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