FS/FS/Mason.pm

   1 package FS::Mason;
   2
   3 use strict;
   4 use vars qw( @ISA @EXPORT_OK $addl_handler_use );
   5 use Exporter;
   6 use Carp;
   7 use File::Slurp qw( slurp );
   8 use HTML::Mason 1.27; #http://www.masonhq.com/?ApacheModPerl2Redirect
   9 use HTML::Mason::Interp;
  10 use HTML::Mason::Compiler::ToObject;
  11
  12 @ISA = qw( Exporter );
  13 @EXPORT_OK = qw( mason_interps );
  14
  15 =head1 NAME
  16
  17 FS::Mason - Initialize the Mason environment
  18
  19 =head1 SYNOPSIS
  20
  21   use FS::Mason qw( mason_interps );
  22
  23   my( $fs_interp, $rt_interp ) = mason_interps('apache');
  24
  25   #OR
  26
  27   my( $fs_interp, $rt_interp ) = mason_interps('standalone'); #XXX name?
  28
  29 =head1 DESCRIPTION
  30
  31 Initializes the Mason environment, loads all Freeside and RT libraries, etc.
  32
  33 =cut
  34
  35 $addl_handler_use = '';
  36 my $addl_handler_use_file = '%%%FREESIDE_CONF%%%/addl_handler_use.pl';
  37 if ( -e $addl_handler_use_file ) {
  38   $addl_handler_use = slurp( $addl_handler_use_file );
  39 }
  40
  41 # List of modules that you want to use from components (see Admin
  42 # manual for details)
  43 {
  44   package HTML::Mason::Commands;
  45
  46   use strict;
  47   use vars qw( %session );
  48   use CGI 3.29 qw(-private_tempfiles); #3.29 to fix RT attachment problems
  49
  50   #breaks quick payment entry
  51   #http://rt.cpan.org/Public/Bug/Display.html?id=37365
  52   die "CGI.pm v3.38 is broken, use any other version >= 3.29".
  53       " (Debian 5.0?  aptitude remove libcgi-pm-perl)"
  54     if $CGI::VERSION == 3.38;
  55
  56   #use CGI::Carp qw(fatalsToBrowser);
  57   use CGI::Cookie;
  58   use List::Util qw( max min );
  59   use Data::Dumper;
  60   use Date::Format;
  61   use Time::Local;
  62   use Time::HiRes;
  63   use Time::Duration;
  64   use DateTime;
  65   use DateTime::Format::Strptime;
  66   use FS::Misc::DateTime qw( parse_datetime );
  67   use Lingua::EN::Inflect qw(PL);
  68   Lingua::EN::Inflect::classical names=>0; #Categorys
  69   use Tie::IxHash;
  70   use URI;
  71   use URI::Escape;
  72   use HTML::Entities;
  73   use HTML::TreeBuilder;
  74   use HTML::TableExtract qw(tree);
  75   use HTML::FormatText;
  76   use HTML::Defang;
  77   use JSON;
  78 #  use XMLRPC::Transport::HTTP;
  79 #  use XMLRPC::Lite; # for XMLRPC::Serializer
  80   use MIME::Base64;
  81   use IO::Handle;
  82   use IO::File;
  83   use IO::Scalar;
  84   #not actually using this yet anyway...# use IPC::Run3 0.036;
  85   use Net::Whois::Raw qw(whois);
  86   if ( $] < 5.006 ) {
  87     eval "use Net::Whois::Raw 0.32 qw(whois)";
  88     die $@ if $@;
  89   }
  90   use Text::CSV_XS;
  91   use Spreadsheet::WriteExcel;
  92   use Spreadsheet::WriteExcel::Utility;
  93   use Business::CreditCard 0.30; #for mask-aware cardtype()
  94   use NetAddr::IP;
  95   use Net::Ping;
  96   use Net::Ping::External;
  97   #if CPAN #7815 ever gets fixed# if ( $Net::Ping::External::VERSION <= 0.12 )
  98   {
  99     no warnings 'redefine';
 100     eval 'sub Net::Ping::External::_ping_linux {
 101             my %args = @_;
 102             my $command = "ping -s $args{size} -c $args{count} -w $args{timeout} $args{host}";
 103             return Net::Ping::External::_ping_system($command, 0);
 104           }
 105          ';
 106     die $@ if $@;
 107   }
 108   use String::Approx qw(amatch);
 109   use Chart::LinesPoints;
 110   use Chart::Mountain;
 111   use Chart::Bars;
 112   use Color::Scheme;
 113   use HTML::Widgets::SelectLayers 0.07; #should go away in favor of
 114                                         #selectlayers.html
 115   use Locale::Country;
 116   use Business::US::USPS::WebTools::AddressStandardization;
 117   use HTML::GoogleMaps;
 118   use Geo::GoogleEarth::Pluggable;
 119   use LWP::UserAgent;
 120   use Storable qw( nfreeze thaw );
 121   use FS;
 122   use FS::UID qw( getotaker dbh datasrc driver_name );
 123   use FS::Record qw( qsearch qsearchs fields dbdef
 124                     str2time_sql str2time_sql_closing
 125                    );
 126   use FS::Conf;
 127   use FS::CGI qw(header menubar table itable ntable idiot
 128                  eidiot myexit http_header);
 129   use FS::UI::Web qw(svc_url);
 130   use FS::UI::Web::small_custview qw(small_custview);
 131   use FS::UI::bytecount;
 132   use FS::Msgcat qw(gettext geterror);
 133   use FS::Misc qw( send_email send_fax ocr_image
 134                    states_hash counties cities state_label
 135                  );
 136   use FS::Misc::eps2png qw( eps2png );
 137   use FS::Report::FCC_477;
 138   use FS::Report::Table;
 139   use FS::Report::Table::Monthly;
 140   use FS::Report::Table::Daily;
 141   use FS::TicketSystem;
 142   use FS::NetworkMonitoringSystem;
 143   use FS::Tron qw( tron_lint );
 144   use FS::Locales;
 145   use FS::Maketext qw( mt emt js_mt );
 146
 147   use FS::agent;
 148   use FS::agent_type;
 149   use FS::domain_record;
 150   use FS::cust_bill;
 151   use FS::cust_bill_pay;
 152   use FS::cust_credit;
 153   use FS::cust_credit_bill;
 154   use FS::cust_main;
 155   use FS::cust_main::Search qw(smart_search);
 156   use FS::cust_main::Import;
 157   use FS::cust_main_county;
 158   use FS::cust_location;
 159   use FS::cust_pay;
 160   use FS::cust_pkg;
 161   use FS::cust_pkg::Import;
 162   use FS::part_pkg_taxclass;
 163   use FS::cust_pkg_reason;
 164   use FS::cust_refund;
 165   use FS::cust_credit_refund;
 166   use FS::cust_pay_refund;
 167   use FS::cust_svc;
 168   use FS::nas;
 169   use FS::part_bill_event;
 170   use FS::part_event;
 171   use FS::part_event_condition;
 172   use FS::part_pkg;
 173   use FS::part_referral;
 174   use FS::part_svc;
 175   use FS::part_svc_router;
 176   use FS::part_virtual_field;
 177   use FS::pay_batch;
 178   use FS::pkg_svc;
 179   use FS::port;
 180   use FS::queue qw(joblisting);
 181   use FS::raddb;
 182   use FS::session;
 183   use FS::svc_acct;
 184   use FS::svc_acct_pop qw(popselector);
 185   use FS::acct_rt_transaction;
 186   use FS::svc_domain;
 187   use FS::svc_forward;
 188   use FS::svc_www;
 189   use FS::router;
 190   use FS::addr_block;
 191   use FS::svc_broadband;
 192   use FS::svc_external;
 193   use FS::type_pkgs;
 194   use FS::part_export;
 195   use FS::part_export_option;
 196   use FS::export_svc;
 197   use FS::export_device;
 198   use FS::msgcat;
 199   use FS::rate;
 200   use FS::rate_region;
 201   use FS::rate_prefix;
 202   use FS::rate_detail;
 203   use FS::usage_class;
 204   use FS::payment_gateway;
 205   use FS::agent_payment_gateway;
 206   use FS::XMLRPC;
 207   use FS::payby;
 208   use FS::cdr;
 209   use FS::cdr_batch;
 210   use FS::inventory_class;
 211   use FS::inventory_item;
 212   use FS::pkg_category;
 213   use FS::pkg_class;
 214   use FS::access_user;
 215   use FS::access_user_pref;
 216   use FS::access_group;
 217   use FS::access_usergroup;
 218   use FS::access_groupagent;
 219   use FS::access_right;
 220   use FS::AccessRight;
 221   use FS::svc_phone;
 222   use FS::phone_device;
 223   use FS::part_device;
 224   use FS::reason_type;
 225   use FS::reason;
 226   use FS::cust_main_note;
 227   use FS::tax_class;
 228   use FS::cust_tax_location;
 229   use FS::part_pkg_taxproduct;
 230   use FS::part_pkg_taxoverride;
 231   use FS::part_pkg_taxrate;
 232   use FS::tax_rate;
 233   use FS::part_pkg_report_option;
 234   use FS::cust_attachment;
 235   use FS::h_cust_pkg;
 236   use FS::h_inventory_item;
 237   use FS::h_svc_acct;
 238   use FS::h_svc_broadband;
 239   use FS::h_svc_domain;
 240   #use FS::h_domain_record;
 241   use FS::h_svc_external;
 242   use FS::h_svc_forward;
 243   use FS::h_svc_phone;
 244   #use FS::h_phone_device;
 245   use FS::h_svc_www;
 246   use FS::cust_statement;
 247   use FS::cust_class;
 248   use FS::cust_category;
 249   use FS::prospect_main;
 250   use FS::contact;
 251   use FS::phone_type;
 252   use FS::svc_pbx;
 253   use FS::discount;
 254   use FS::cust_pkg_discount;
 255   use FS::cust_bill_pkg_discount;
 256   use FS::svc_mailinglist;
 257   use FS::cgp_rule;
 258   use FS::cgp_rule_condition;
 259   use FS::cgp_rule_action;
 260   use FS::bill_batch;
 261   use FS::cust_bill_batch;
 262   use FS::rate_time;
 263   use FS::rate_time_interval;
 264   use FS::msg_template;
 265   use FS::part_tag;
 266   use FS::acct_snarf;
 267   use FS::part_pkg_discount;
 268   use FS::svc_cert;
 269   use FS::svc_dsl;
 270   use FS::qual;
 271   use FS::qual_option;
 272   use FS::dsl_note;
 273   use FS::part_pkg_vendor;
 274   use FS::cust_note_class;
 275   use FS::svc_port;
 276   use FS::lata;
 277   use FS::did_vendor;
 278   use FS::did_order;
 279   use FS::torrus_srvderive;
 280   use FS::torrus_srvderive_component;
 281   use FS::areacode;
 282   use FS::svc_dish;
 283   use FS::h_svc_dish;
 284   use FS::svc_hardware;
 285   use FS::h_svc_hardware;
 286   use FS::hardware_class;
 287   use FS::hardware_type;
 288   use FS::hardware_status;
 289   use FS::did_order_item;
 290   use FS::msa;
 291   use FS::rate_center;
 292   use FS::cust_msg;
 293   use FS::radius_group;
 294   use FS::template_content;
 295   use FS::dsl_device;
 296   use FS::nas;
 297   use FS::nas;
 298   use FS::export_nas;
 299   use FS::legacy_cust_bill;
 300   use FS::rate_tier;
 301   use FS::rate_tier_detail;
 302   use FS::radius_attr;
 303   use FS::discount_plan;
 304   use FS::tower;
 305   use FS::tower_sector;
 306   # Sammath Naur
 307
 308   if ( $FS::Mason::addl_handler_use ) {
 309     eval $FS::Mason::addl_handler_use;
 310     die $@ if $@;
 311   }
 312
 313   if ( %%%RT_ENABLED%%% ) {
 314     eval '
 315       use lib ( "/opt/rt3/local/lib", "/opt/rt3/lib" );
 316       use vars qw($Nobody $SystemUser);
 317       use RT;
 318       use RT::Util;
 319       use RT::Tickets;
 320       use RT::Transactions;
 321       use RT::Users;
 322       use RT::CurrentUser;
 323       use RT::Templates;
 324       use RT::Queues;
 325       use RT::ScripActions;
 326       use RT::ScripConditions;
 327       use RT::Scrips;
 328       use RT::Groups;
 329       use RT::GroupMembers;
 330       use RT::CustomFields;
 331       use RT::CustomFieldValues;
 332       use RT::ObjectCustomFieldValues;
 333
 334       #blah.  manually updated from RT::Interface::Web::Handler
 335       use RT::Interface::Web;
 336       use MIME::Entity;
 337       use Text::Wrapper;
 338       use Time::ParseDate;
 339       use Time::HiRes;
 340       use HTML::Scrubber;
 341
 342       #blah.  not even in RT::Interface::Web::Handler, just in
 343       #html/NoAuth/css/dhandler and rt-test-dependencies.  ask for it here
 344       #to throw a real error instead of just a mysterious unstyled RT
 345       use CSS::Squish 0.06;
 346
 347       use RT::Interface::Web::Request;
 348
 349       #nother undeclared web UI dep (for ticket links graph)
 350       use IPC::Run::SafeHandles;
 351
 352       #slow, unreliable, segfaults and is optional
 353       #see rt/html/Ticket/Elements/ShowTransactionAttachments
 354       #use Text::Quoted;
 355
 356       #?#use File::Path qw( rmtree );
 357       #?#use File::Glob qw( bsd_glob );
 358       #?#use File::Spec::Unix;
 359
 360     ';
 361     die $@ if $@;
 362   }
 363
 364   *CGI::redirect = sub {
 365     my $self = shift;
 366     my $cookie = '';
 367     if ( $_[0] eq '-cookie' ) { #this isn't actually used at the moment
 368       (my $x, $cookie) = (shift, shift);
 369       $HTML::Mason::r->err_headers_out->add( 'Set-cookie' => $cookie );
 370     }
 371     my $location = shift;
 372
 373     use vars qw($m);
 374
 375     # false laziness w/below
 376     if ( defined(@DBIx::Profile::ISA) ) {
 377
 378       if ( $FS::CurrentUser::CurrentUser->option('show_db_profile') ) {
 379
 380         #profiling redirect
 381
 382         my $page =
 383           qq!<HTML><BODY>Redirect to <A HREF="$location">$location</A>!.
 384           '<BR><BR><PRE>'.
 385             ( UNIVERSAL::can(dbh, 'sprintProfile')
 386                 ? encode_entities(dbh->sprintProfile())
 387                 : 'DBIx::Profile missing sprintProfile method;'.
 388                   'unpatched or too old?'                        ).
 389           #"\n\n". &sprintAutoProfile().  '</PRE>'.
 390           "\n\n".                         '</PRE>'.
 391           '</BODY></HTML>';
 392
 393
 394         dbh->{'private_profile'} = {};
 395         return $page;
 396
 397       } else {
 398
 399         #clear db profile, but normal redirect
 400         dbh->{'private_profile'} = {};
 401         $m->redirect($location);
 402         '';
 403
 404       }
 405
 406     } else { #normal redirect
 407
 408       $m->redirect($location);
 409       '';
 410
 411     }
 412
 413   };
 414
 415   sub include {
 416     use vars qw($m);
 417     #carp #should just switch to <& &> syntax
 418     $m->scomp(@_);
 419   }
 420
 421   sub errorpage {
 422     use vars qw($m);
 423     $m->comp('/elements/errorpage.html', @_);
 424   }
 425
 426   sub errorpage_popup {
 427     use vars qw($m);
 428     $m->comp('/elements/errorpage-popup.html', @_);
 429   }
 430
 431   sub redirect {
 432     my( $location ) = @_;
 433     use vars qw($m);
 434     $m->clear_buffer;
 435     #false laziness w/above
 436     if ( defined(@DBIx::Profile::ISA) ) {
 437
 438       if ( $FS::CurrentUser::CurrentUser->option('show_db_profile') ) {
 439
 440         #profiling redirect
 441
 442         $m->print(
 443           qq!<HTML><BODY>Redirect to <A HREF="$location">$location</A>!.
 444           '<BR><BR><PRE>'.
 445             ( UNIVERSAL::can(dbh, 'sprintProfile')
 446                 ? encode_entities(dbh->sprintProfile())
 447                 : 'DBIx::Profile missing sprintProfile method;'.
 448                   'unpatched or too old?'                        ).
 449           #"\n\n". &sprintAutoProfile().  '</PRE>'.
 450           "\n\n".                         '</PRE>'.
 451           '</BODY></HTML>'
 452         );
 453
 454         dbh->{'private_profile'} = {};
 455
 456       } else {
 457
 458         #clear db profile, but normal redirect
 459         dbh->{'private_profile'} = {};
 460         $m->redirect($location);
 461
 462       }
 463
 464     } else { #normal redirect
 465
 466       $m->redirect($location);
 467
 468     }
 469
 470   }
 471
 472 } # end package HTML::Mason::Commands;
 473
 474 =head1 SUBROUTINE
 475
 476 =over 4
 477
 478 =item mason_interps [ MODE [ OPTION => VALUE ... ] ]
 479
 480 Returns a list consisting of two HTML::Mason::Interp objects, the first for
 481 Freeside pages, and the second for RT pages.
 482
 483 MODE can be 'apache' or 'standalone'.  If not specified, defaults to 'apache'.
 484
 485 Options and values can be passed following mode.  Currently available options
 486 are:
 487
 488 I<outbuf> should be set to a scalar reference in standalone mode.
 489
 490 =cut
 491
 492 my %defang_opts = ( attribs_to_callback => ['src'], attribs_callback => sub { 1 });
 493
 494 sub mason_interps {
 495   my $mode = shift || 'apache';
 496   my %opt = @_;
 497
 498   #my $request_class = 'HTML::Mason::Request'.
 499                       #( $mode eq 'apache' ? '::ApacheHandler' : '' );
 500   my $request_class = $mode eq 'standalone' ? 'FS::Mason::StandaloneRequest'
 501                                             : 'FS::Mason::Request';
 502
 503   #not entirely sure it belongs here, but what the hey
 504   if ( %%%RT_ENABLED%%% && $mode ne 'standalone' ) {
 505     RT::LoadConfig();
 506   }
 507
 508   # A hook supporting strange legacy ways people (well, SG) have added stuff on
 509
 510   my @addl_comp_root = ();
 511   my $addl_comp_root_file = '%%%FREESIDE_CONF%%%/addl_comp_root.pl';
 512   if ( -e $addl_comp_root_file ) {
 513     warn "reading $addl_comp_root_file\n";
 514     my $text = slurp( $addl_comp_root_file );
 515     my @addl = eval $text;
 516     if ( @addl && ! $@ ) {
 517       @addl_comp_root = @addl;
 518     } elsif ($@) {
 519       warn "error parsing $addl_comp_root_file: $@\n";
 520     }
 521   }
 522
 523   my $fs_comp_root =
 524     scalar(@addl_comp_root)
 525       ? [
 526           [ 'freeside'=>'%%%FREESIDE_DOCUMENT_ROOT%%%' ],
 527           @addl_comp_root,
 528         ]
 529       : '%%%FREESIDE_DOCUMENT_ROOT%%%';
 530
 531   my %interp = (
 532     request_class        => $request_class,
 533     data_dir             => '%%%MASONDATA%%%',
 534     error_mode           => 'output',
 535     error_format         => 'html',
 536     ignore_warnings_expr => '.',
 537   );
 538
 539   $interp{out_method} = $opt{outbuf} if $mode eq 'standalone' && $opt{outbuf};
 540
 541   my $html_defang = new HTML::Defang (%defang_opts);
 542
 543   #false laziness w/ FS::Maketext js_mt
 544   my $js_string_sub = sub {
 545     #${$_[0]} =~ s/(['\\\n])/'\\'.($1 eq "\n" ? 'n' : $1)/ge;
 546     ${$_[0]} =~ s/(['\\])/\\$1/g;
 547     ${$_[0]} =~ s/\r/\\r/g;
 548     ${$_[0]} =~ s/\n/\\n/g;
 549     ${$_[0]} = "'". ${$_[0]}. "'";
 550   };
 551
 552   my $defang_sub = sub {
 553     ${$_[0]} = $html_defang->defang(${$_[0]});
 554   };
 555
 556   my $fs_interp = new HTML::Mason::Interp (
 557     %interp,
 558     comp_root    => $fs_comp_root,
 559     escape_flags => { 'js_string'   => $js_string_sub,
 560                       'defang'      => $defang_sub,
 561                     },
 562     compiler     => HTML::Mason::Compiler::ToObject->new(
 563                       allow_globals        => [qw(%session)],
 564                     ),
 565   );
 566
 567   my $rt_interp = new HTML::Mason::Interp (
 568     %interp,
 569     comp_root    => [
 570                       [ 'rt'       => '%%%FREESIDE_DOCUMENT_ROOT%%%/rt' ],
 571                       [ 'freeside' => '%%%FREESIDE_DOCUMENT_ROOT%%%'    ],
 572                     ],
 573     escape_flags => { 'h'         => \&RT::Interface::Web::EscapeUTF8,
 574                       'js_string' => $js_string_sub,
 575                     },
 576     compiler     => HTML::Mason::Compiler::ToObject->new(
 577                       default_escape_flags => 'h',
 578                       allow_globals        => [qw(%session)],
 579                     ),
 580   );
 581
 582   ( $fs_interp, $rt_interp );
 583
 584 }
 585
 586 =back
 587
 588 =head1 BUGS
 589
 590 Lurking in the darkness...
 591
 592 =head1 SEE ALSO
 593
 594 L<HTML::Mason>, L<FS>, L<RT>
 595
 596 =cut
 597
 598 1;