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 LWP::UserAgent;
 118   use Storable qw( nfreeze thaw );
 119   use FS;
 120   use FS::UID qw( getotaker dbh datasrc driver_name );
 121   use FS::Record qw( qsearch qsearchs fields dbdef
 122                     str2time_sql str2time_sql_closing
 123                    );
 124   use FS::Conf;
 125   use FS::CGI qw(header menubar table itable ntable idiot
 126                  eidiot myexit http_header);
 127   use FS::UI::Web qw(svc_url);
 128   use FS::UI::Web::small_custview qw(small_custview);
 129   use FS::UI::bytecount;
 130   use FS::Msgcat qw(gettext geterror);
 131   use FS::Misc qw( send_email send_fax ocr_image
 132                    states_hash counties cities state_label
 133                  );
 134   use FS::Misc::eps2png qw( eps2png );
 135   use FS::Report::FCC_477;
 136   use FS::Report::Table::Monthly;
 137   use FS::TicketSystem;
 138   use FS::NetworkMonitoringSystem;
 139   use FS::Tron qw( tron_lint );
 140
 141   use FS::agent;
 142   use FS::agent_type;
 143   use FS::domain_record;
 144   use FS::cust_bill;
 145   use FS::cust_bill_pay;
 146   use FS::cust_credit;
 147   use FS::cust_credit_bill;
 148   use FS::cust_main;
 149   use FS::cust_main::Search qw(smart_search);
 150   use FS::cust_main::Import;
 151   use FS::cust_main_county;
 152   use FS::cust_location;
 153   use FS::cust_pay;
 154   use FS::cust_pkg;
 155   use FS::cust_pkg::Import;
 156   use FS::part_pkg_taxclass;
 157   use FS::cust_pkg_reason;
 158   use FS::cust_refund;
 159   use FS::cust_credit_refund;
 160   use FS::cust_pay_refund;
 161   use FS::cust_svc;
 162   use FS::nas;
 163   use FS::part_bill_event;
 164   use FS::part_event;
 165   use FS::part_event_condition;
 166   use FS::part_pkg;
 167   use FS::part_referral;
 168   use FS::part_svc;
 169   use FS::part_svc_router;
 170   use FS::part_virtual_field;
 171   use FS::pay_batch;
 172   use FS::pkg_svc;
 173   use FS::port;
 174   use FS::queue qw(joblisting);
 175   use FS::raddb;
 176   use FS::session;
 177   use FS::svc_acct;
 178   use FS::svc_acct_pop qw(popselector);
 179   use FS::acct_rt_transaction;
 180   use FS::svc_domain;
 181   use FS::svc_forward;
 182   use FS::svc_www;
 183   use FS::router;
 184   use FS::addr_block;
 185   use FS::svc_broadband;
 186   use FS::svc_external;
 187   use FS::type_pkgs;
 188   use FS::part_export;
 189   use FS::part_export_option;
 190   use FS::export_svc;
 191   use FS::export_device;
 192   use FS::msgcat;
 193   use FS::rate;
 194   use FS::rate_region;
 195   use FS::rate_prefix;
 196   use FS::rate_detail;
 197   use FS::usage_class;
 198   use FS::payment_gateway;
 199   use FS::agent_payment_gateway;
 200   use FS::XMLRPC;
 201   use FS::payby;
 202   use FS::cdr;
 203   use FS::cdr_batch;
 204   use FS::inventory_class;
 205   use FS::inventory_item;
 206   use FS::pkg_category;
 207   use FS::pkg_class;
 208   use FS::access_user;
 209   use FS::access_user_pref;
 210   use FS::access_group;
 211   use FS::access_usergroup;
 212   use FS::access_groupagent;
 213   use FS::access_right;
 214   use FS::AccessRight;
 215   use FS::svc_phone;
 216   use FS::phone_device;
 217   use FS::part_device;
 218   use FS::reason_type;
 219   use FS::reason;
 220   use FS::cust_main_note;
 221   use FS::tax_class;
 222   use FS::cust_tax_location;
 223   use FS::part_pkg_taxproduct;
 224   use FS::part_pkg_taxoverride;
 225   use FS::part_pkg_taxrate;
 226   use FS::tax_rate;
 227   use FS::part_pkg_report_option;
 228   use FS::cust_attachment;
 229   use FS::h_cust_pkg;
 230   use FS::h_inventory_item;
 231   use FS::h_svc_acct;
 232   use FS::h_svc_broadband;
 233   use FS::h_svc_domain;
 234   #use FS::h_domain_record;
 235   use FS::h_svc_external;
 236   use FS::h_svc_forward;
 237   use FS::h_svc_phone;
 238   #use FS::h_phone_device;
 239   use FS::h_svc_www;
 240   use FS::cust_statement;
 241   use FS::cust_class;
 242   use FS::cust_category;
 243   use FS::prospect_main;
 244   use FS::contact;
 245   use FS::phone_type;
 246   use FS::svc_pbx;
 247   use FS::discount;
 248   use FS::cust_pkg_discount;
 249   use FS::cust_bill_pkg_discount;
 250   use FS::svc_mailinglist;
 251   use FS::cgp_rule;
 252   use FS::cgp_rule_condition;
 253   use FS::cgp_rule_action;
 254   use FS::bill_batch;
 255   use FS::cust_bill_batch;
 256   use FS::rate_time;
 257   use FS::rate_time_interval;
 258   use FS::msg_template;
 259   use FS::part_tag;
 260   use FS::acct_snarf;
 261   use FS::part_pkg_discount;
 262   use FS::svc_cert;
 263   use FS::svc_dsl;
 264   use FS::qual;
 265   use FS::qual_option;
 266   use FS::dsl_note;
 267   use FS::part_pkg_vendor;
 268   use FS::cust_note_class;
 269   use FS::svc_port;
 270   use FS::lata;
 271   use FS::did_vendor;
 272   use FS::did_order;
 273   use FS::torrus_srvderive;
 274   use FS::torrus_srvderive_component;
 275   use FS::areacode;
 276   # Sammath Naur
 277
 278   if ( $FS::Mason::addl_handler_use ) {
 279     eval $FS::Mason::addl_handler_use;
 280     die $@ if $@;
 281   }
 282
 283   if ( %%%RT_ENABLED%%% ) {
 284     eval '
 285       use lib ( "/opt/rt3/local/lib", "/opt/rt3/lib" );
 286       use vars qw($Nobody $SystemUser);
 287       use RT;
 288       use RT::Util;
 289       use RT::Tickets;
 290       use RT::Transactions;
 291       use RT::Users;
 292       use RT::CurrentUser;
 293       use RT::Templates;
 294       use RT::Queues;
 295       use RT::ScripActions;
 296       use RT::ScripConditions;
 297       use RT::Scrips;
 298       use RT::Groups;
 299       use RT::GroupMembers;
 300       use RT::CustomFields;
 301       use RT::CustomFieldValues;
 302       use RT::ObjectCustomFieldValues;
 303
 304       #blah.  manually updated from RT::Interface::Web::Handler
 305       use RT::Interface::Web;
 306       use MIME::Entity;
 307       use Text::Wrapper;
 308       use Time::ParseDate;
 309       use Time::HiRes;
 310       use HTML::Scrubber;
 311
 312       #blah.  not even in RT::Interface::Web::Handler, just in
 313       #html/NoAuth/css/dhandler and rt-test-dependencies.  ask for it here
 314       #to throw a real error instead of just a mysterious unstyled RT
 315       use CSS::Squish 0.06;
 316
 317       use RT::Interface::Web::Request;
 318
 319       #nother undeclared web UI dep (for ticket links graph)
 320       use IPC::Run::SafeHandles;
 321
 322       #slow, unreliable, segfaults and is optional
 323       #see rt/html/Ticket/Elements/ShowTransactionAttachments
 324       #use Text::Quoted;
 325
 326       #?#use File::Path qw( rmtree );
 327       #?#use File::Glob qw( bsd_glob );
 328       #?#use File::Spec::Unix;
 329
 330     ';
 331     die $@ if $@;
 332   }
 333
 334   *CGI::redirect = sub {
 335     my $self = shift;
 336     my $cookie = '';
 337     if ( $_[0] eq '-cookie' ) { #this isn't actually used at the moment
 338       (my $x, $cookie) = (shift, shift);
 339       $HTML::Mason::r->err_headers_out->add( 'Set-cookie' => $cookie );
 340     }
 341     my $location = shift;
 342
 343     use vars qw($m);
 344
 345     # false laziness w/below
 346     if ( defined(@DBIx::Profile::ISA) ) {
 347
 348       if ( $FS::CurrentUser::CurrentUser->option('show_db_profile') ) {
 349
 350         #profiling redirect
 351
 352         my $page =
 353           qq!<HTML><BODY>Redirect to <A HREF="$location">$location</A>!.
 354           '<BR><BR><PRE>'.
 355             ( UNIVERSAL::can(dbh, 'sprintProfile')
 356                 ? encode_entities(dbh->sprintProfile())
 357                 : 'DBIx::Profile missing sprintProfile method;'.
 358                   'unpatched or too old?'                        ).
 359           #"\n\n". &sprintAutoProfile().  '</PRE>'.
 360           "\n\n".                         '</PRE>'.
 361           '</BODY></HTML>';
 362
 363
 364         dbh->{'private_profile'} = {};
 365         return $page;
 366
 367       } else {
 368
 369         #clear db profile, but normal redirect
 370         dbh->{'private_profile'} = {};
 371         $m->redirect($location);
 372         '';
 373
 374       }
 375
 376     } else { #normal redirect
 377
 378       $m->redirect($location);
 379       '';
 380
 381     }
 382
 383   };
 384
 385   sub include {
 386     use vars qw($m);
 387     #carp #should just switch to <& &> syntax
 388     $m->scomp(@_);
 389   }
 390
 391   sub errorpage {
 392     use vars qw($m);
 393     $m->comp('/elements/errorpage.html', @_);
 394   }
 395
 396   sub errorpage_popup {
 397     use vars qw($m);
 398     $m->comp('/elements/errorpage-popup.html', @_);
 399   }
 400
 401   sub redirect {
 402     my( $location ) = @_;
 403     use vars qw($m);
 404     $m->clear_buffer;
 405     #false laziness w/above
 406     if ( defined(@DBIx::Profile::ISA) ) {
 407
 408       if ( $FS::CurrentUser::CurrentUser->option('show_db_profile') ) {
 409
 410         #profiling redirect
 411
 412         $m->print(
 413           qq!<HTML><BODY>Redirect to <A HREF="$location">$location</A>!.
 414           '<BR><BR><PRE>'.
 415             ( UNIVERSAL::can(dbh, 'sprintProfile')
 416                 ? encode_entities(dbh->sprintProfile())
 417                 : 'DBIx::Profile missing sprintProfile method;'.
 418                   'unpatched or too old?'                        ).
 419           #"\n\n". &sprintAutoProfile().  '</PRE>'.
 420           "\n\n".                         '</PRE>'.
 421           '</BODY></HTML>'
 422         );
 423
 424         dbh->{'private_profile'} = {};
 425
 426       } else {
 427
 428         #clear db profile, but normal redirect
 429         dbh->{'private_profile'} = {};
 430         $m->redirect($location);
 431
 432       }
 433
 434     } else { #normal redirect
 435
 436       $m->redirect($location);
 437
 438     }
 439
 440   }
 441
 442 } # end package HTML::Mason::Commands;
 443
 444 =head1 SUBROUTINE
 445
 446 =over 4
 447
 448 =item mason_interps [ MODE [ OPTION => VALUE ... ] ]
 449
 450 Returns a list consisting of two HTML::Mason::Interp objects, the first for
 451 Freeside pages, and the second for RT pages.
 452
 453 MODE can be 'apache' or 'standalone'.  If not specified, defaults to 'apache'.
 454
 455 Options and values can be passed following mode.  Currently available options
 456 are:
 457
 458 I<outbuf> should be set to a scalar reference in standalone mode.
 459
 460 =cut
 461
 462 my %defang_opts = ( attribs_to_callback => ['src'], attribs_callback => sub { 1 });
 463
 464 sub mason_interps {
 465   my $mode = shift || 'apache';
 466   my %opt = @_;
 467
 468   #my $request_class = 'HTML::Mason::Request'.
 469                       #( $mode eq 'apache' ? '::ApacheHandler' : '' );
 470   my $request_class = $mode eq 'standalone' ? 'FS::Mason::StandaloneRequest'
 471                                             : 'FS::Mason::Request';
 472
 473   #not entirely sure it belongs here, but what the hey
 474   if ( %%%RT_ENABLED%%% && $mode ne 'standalone' ) {
 475     RT::LoadConfig();
 476   }
 477
 478   # A hook supporting strange legacy ways people (well, SG) have added stuff on
 479
 480   my @addl_comp_root = ();
 481   my $addl_comp_root_file = '%%%FREESIDE_CONF%%%/addl_comp_root.pl';
 482   if ( -e $addl_comp_root_file ) {
 483     warn "reading $addl_comp_root_file\n";
 484     my $text = slurp( $addl_comp_root_file );
 485     my @addl = eval $text;
 486     if ( @addl && ! $@ ) {
 487       @addl_comp_root = @addl;
 488     } elsif ($@) {
 489       warn "error parsing $addl_comp_root_file: $@\n";
 490     }
 491   }
 492
 493   my $fs_comp_root =
 494     scalar(@addl_comp_root)
 495       ? [
 496           [ 'freeside'=>'%%%FREESIDE_DOCUMENT_ROOT%%%' ],
 497           @addl_comp_root,
 498         ]
 499       : '%%%FREESIDE_DOCUMENT_ROOT%%%';
 500
 501   my %interp = (
 502     request_class        => $request_class,
 503     data_dir             => '%%%MASONDATA%%%',
 504     error_mode           => 'output',
 505     error_format         => 'html',
 506     ignore_warnings_expr => '.',
 507   );
 508
 509   $interp{out_method} = $opt{outbuf} if $mode eq 'standalone' && $opt{outbuf};
 510
 511   my $html_defang = new HTML::Defang (%defang_opts);
 512
 513   my $js_string_sub = sub {
 514     #${$_[0]} =~ s/(['\\\n])/'\\'.($1 eq "\n" ? 'n' : $1)/ge;
 515     ${$_[0]} =~ s/(['\\])/\\$1/g;
 516     ${$_[0]} =~ s/\r/\\r/g;
 517     ${$_[0]} =~ s/\n/\\n/g;
 518     ${$_[0]} = "'". ${$_[0]}. "'";
 519   };
 520
 521   my $fs_interp = new HTML::Mason::Interp (
 522     %interp,
 523     comp_root    => $fs_comp_root,
 524     escape_flags => { 'js_string' => $js_string_sub,
 525                       'defang'    => sub {
 526                         ${$_[0]} = $html_defang->defang(${$_[0]});
 527                       },
 528                     },
 529     compiler     => HTML::Mason::Compiler::ToObject->new(
 530                       allow_globals        => [qw(%session)],
 531                     ),
 532   );
 533
 534   my $rt_interp = new HTML::Mason::Interp (
 535     %interp,
 536     comp_root    => [
 537                       [ 'rt'       => '%%%FREESIDE_DOCUMENT_ROOT%%%/rt' ],
 538                       [ 'freeside' => '%%%FREESIDE_DOCUMENT_ROOT%%%'    ],
 539                     ],
 540     escape_flags => { 'h'         => \&RT::Interface::Web::EscapeUTF8,
 541                       'js_string' => $js_string_sub,
 542                     },
 543     compiler     => HTML::Mason::Compiler::ToObject->new(
 544                       default_escape_flags => 'h',
 545                       allow_globals        => [qw(%session)],
 546                     ),
 547   );
 548
 549   ( $fs_interp, $rt_interp );
 550
 551 }
 552
 553 =back
 554
 555 =head1 BUGS
 556
 557 Lurking in the darkness...
 558
 559 =head1 SEE ALSO
 560
 561 L<HTML::Mason>, L<FS>, L<RT>
 562
 563 =cut
 564
 565 1;