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