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