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 js_mt );
 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   use FS::radius_group;
 292   use FS::template_content;
 293   use FS::dsl_device;
 294   use FS::nas;
 295   use FS::nas;
 296   use FS::export_nas;
 297   use FS::legacy_cust_bill;
 298   use FS::rate_tier;
 299   use FS::rate_tier_detail;
 300   use FS::radius_attr;
 301   use FS::discount_plan;
 302   # Sammath Naur
 303
 304   if ( $FS::Mason::addl_handler_use ) {
 305     eval $FS::Mason::addl_handler_use;
 306     die $@ if $@;
 307   }
 308
 309   if ( %%%RT_ENABLED%%% ) {
 310     eval '
 311       use lib ( "/opt/rt3/local/lib", "/opt/rt3/lib" );
 312       use vars qw($Nobody $SystemUser);
 313       use RT;
 314       use RT::Util;
 315       use RT::Tickets;
 316       use RT::Transactions;
 317       use RT::Users;
 318       use RT::CurrentUser;
 319       use RT::Templates;
 320       use RT::Queues;
 321       use RT::ScripActions;
 322       use RT::ScripConditions;
 323       use RT::Scrips;
 324       use RT::Groups;
 325       use RT::GroupMembers;
 326       use RT::CustomFields;
 327       use RT::CustomFieldValues;
 328       use RT::ObjectCustomFieldValues;
 329
 330       #blah.  manually updated from RT::Interface::Web::Handler
 331       use RT::Interface::Web;
 332       use MIME::Entity;
 333       use Text::Wrapper;
 334       use Time::ParseDate;
 335       use Time::HiRes;
 336       use HTML::Scrubber;
 337
 338       #blah.  not even in RT::Interface::Web::Handler, just in
 339       #html/NoAuth/css/dhandler and rt-test-dependencies.  ask for it here
 340       #to throw a real error instead of just a mysterious unstyled RT
 341       use CSS::Squish 0.06;
 342
 343       use RT::Interface::Web::Request;
 344
 345       #nother undeclared web UI dep (for ticket links graph)
 346       use IPC::Run::SafeHandles;
 347
 348       #slow, unreliable, segfaults and is optional
 349       #see rt/html/Ticket/Elements/ShowTransactionAttachments
 350       #use Text::Quoted;
 351
 352       #?#use File::Path qw( rmtree );
 353       #?#use File::Glob qw( bsd_glob );
 354       #?#use File::Spec::Unix;
 355
 356     ';
 357     die $@ if $@;
 358   }
 359
 360   *CGI::redirect = sub {
 361     my $self = shift;
 362     my $cookie = '';
 363     if ( $_[0] eq '-cookie' ) { #this isn't actually used at the moment
 364       (my $x, $cookie) = (shift, shift);
 365       $HTML::Mason::r->err_headers_out->add( 'Set-cookie' => $cookie );
 366     }
 367     my $location = shift;
 368
 369     use vars qw($m);
 370
 371     # false laziness w/below
 372     if ( defined(@DBIx::Profile::ISA) ) {
 373
 374       if ( $FS::CurrentUser::CurrentUser->option('show_db_profile') ) {
 375
 376         #profiling redirect
 377
 378         my $page =
 379           qq!<HTML><BODY>Redirect to <A HREF="$location">$location</A>!.
 380           '<BR><BR><PRE>'.
 381             ( UNIVERSAL::can(dbh, 'sprintProfile')
 382                 ? encode_entities(dbh->sprintProfile())
 383                 : 'DBIx::Profile missing sprintProfile method;'.
 384                   'unpatched or too old?'                        ).
 385           #"\n\n". &sprintAutoProfile().  '</PRE>'.
 386           "\n\n".                         '</PRE>'.
 387           '</BODY></HTML>';
 388
 389
 390         dbh->{'private_profile'} = {};
 391         return $page;
 392
 393       } else {
 394
 395         #clear db profile, but normal redirect
 396         dbh->{'private_profile'} = {};
 397         $m->redirect($location);
 398         '';
 399
 400       }
 401
 402     } else { #normal redirect
 403
 404       $m->redirect($location);
 405       '';
 406
 407     }
 408
 409   };
 410
 411   sub include {
 412     use vars qw($m);
 413     #carp #should just switch to <& &> syntax
 414     $m->scomp(@_);
 415   }
 416
 417   sub errorpage {
 418     use vars qw($m);
 419     $m->comp('/elements/errorpage.html', @_);
 420   }
 421
 422   sub errorpage_popup {
 423     use vars qw($m);
 424     $m->comp('/elements/errorpage-popup.html', @_);
 425   }
 426
 427   sub redirect {
 428     my( $location ) = @_;
 429     use vars qw($m);
 430     $m->clear_buffer;
 431     #false laziness w/above
 432     if ( defined(@DBIx::Profile::ISA) ) {
 433
 434       if ( $FS::CurrentUser::CurrentUser->option('show_db_profile') ) {
 435
 436         #profiling redirect
 437
 438         $m->print(
 439           qq!<HTML><BODY>Redirect to <A HREF="$location">$location</A>!.
 440           '<BR><BR><PRE>'.
 441             ( UNIVERSAL::can(dbh, 'sprintProfile')
 442                 ? encode_entities(dbh->sprintProfile())
 443                 : 'DBIx::Profile missing sprintProfile method;'.
 444                   'unpatched or too old?'                        ).
 445           #"\n\n". &sprintAutoProfile().  '</PRE>'.
 446           "\n\n".                         '</PRE>'.
 447           '</BODY></HTML>'
 448         );
 449
 450         dbh->{'private_profile'} = {};
 451
 452       } else {
 453
 454         #clear db profile, but normal redirect
 455         dbh->{'private_profile'} = {};
 456         $m->redirect($location);
 457
 458       }
 459
 460     } else { #normal redirect
 461
 462       $m->redirect($location);
 463
 464     }
 465
 466   }
 467
 468 } # end package HTML::Mason::Commands;
 469
 470 =head1 SUBROUTINE
 471
 472 =over 4
 473
 474 =item mason_interps [ MODE [ OPTION => VALUE ... ] ]
 475
 476 Returns a list consisting of two HTML::Mason::Interp objects, the first for
 477 Freeside pages, and the second for RT pages.
 478
 479 MODE can be 'apache' or 'standalone'.  If not specified, defaults to 'apache'.
 480
 481 Options and values can be passed following mode.  Currently available options
 482 are:
 483
 484 I<outbuf> should be set to a scalar reference in standalone mode.
 485
 486 =cut
 487
 488 my %defang_opts = ( attribs_to_callback => ['src'], attribs_callback => sub { 1 });
 489
 490 sub mason_interps {
 491   my $mode = shift || 'apache';
 492   my %opt = @_;
 493
 494   #my $request_class = 'HTML::Mason::Request'.
 495                       #( $mode eq 'apache' ? '::ApacheHandler' : '' );
 496   my $request_class = $mode eq 'standalone' ? 'FS::Mason::StandaloneRequest'
 497                                             : 'FS::Mason::Request';
 498
 499   #not entirely sure it belongs here, but what the hey
 500   if ( %%%RT_ENABLED%%% && $mode ne 'standalone' ) {
 501     RT::LoadConfig();
 502   }
 503
 504   # A hook supporting strange legacy ways people (well, SG) have added stuff on
 505
 506   my @addl_comp_root = ();
 507   my $addl_comp_root_file = '%%%FREESIDE_CONF%%%/addl_comp_root.pl';
 508   if ( -e $addl_comp_root_file ) {
 509     warn "reading $addl_comp_root_file\n";
 510     my $text = slurp( $addl_comp_root_file );
 511     my @addl = eval $text;
 512     if ( @addl && ! $@ ) {
 513       @addl_comp_root = @addl;
 514     } elsif ($@) {
 515       warn "error parsing $addl_comp_root_file: $@\n";
 516     }
 517   }
 518
 519   my $fs_comp_root =
 520     scalar(@addl_comp_root)
 521       ? [
 522           [ 'freeside'=>'%%%FREESIDE_DOCUMENT_ROOT%%%' ],
 523           @addl_comp_root,
 524         ]
 525       : '%%%FREESIDE_DOCUMENT_ROOT%%%';
 526
 527   my %interp = (
 528     request_class        => $request_class,
 529     data_dir             => '%%%MASONDATA%%%',
 530     error_mode           => 'output',
 531     error_format         => 'html',
 532     ignore_warnings_expr => '.',
 533   );
 534
 535   $interp{out_method} = $opt{outbuf} if $mode eq 'standalone' && $opt{outbuf};
 536
 537   my $html_defang = new HTML::Defang (%defang_opts);
 538
 539   #false laziness w/ FS::Maketext js_mt
 540   my $js_string_sub = sub {
 541     #${$_[0]} =~ s/(['\\\n])/'\\'.($1 eq "\n" ? 'n' : $1)/ge;
 542     ${$_[0]} =~ s/(['\\])/\\$1/g;
 543     ${$_[0]} =~ s/\r/\\r/g;
 544     ${$_[0]} =~ s/\n/\\n/g;
 545     ${$_[0]} = "'". ${$_[0]}. "'";
 546   };
 547
 548   my $defang_sub = sub {
 549     ${$_[0]} = $html_defang->defang(${$_[0]});
 550   };
 551
 552   my $fs_interp = new HTML::Mason::Interp (
 553     %interp,
 554     comp_root    => $fs_comp_root,
 555     escape_flags => { 'js_string'   => $js_string_sub,
 556                       'defang'      => $defang_sub,
 557                     },
 558     compiler     => HTML::Mason::Compiler::ToObject->new(
 559                       allow_globals        => [qw(%session)],
 560                     ),
 561   );
 562
 563   my $rt_interp = new HTML::Mason::Interp (
 564     %interp,
 565     comp_root    => [
 566                       [ 'rt'       => '%%%FREESIDE_DOCUMENT_ROOT%%%/rt' ],
 567                       [ 'freeside' => '%%%FREESIDE_DOCUMENT_ROOT%%%'    ],
 568                     ],
 569     escape_flags => { 'h'         => \&RT::Interface::Web::EscapeUTF8,
 570                       'js_string' => $js_string_sub,
 571                     },
 572     compiler     => HTML::Mason::Compiler::ToObject->new(
 573                       default_escape_flags => 'h',
 574                       allow_globals        => [qw(%session)],
 575                     ),
 576   );
 577
 578   ( $fs_interp, $rt_interp );
 579
 580 }
 581
 582 =back
 583
 584 =head1 BUGS
 585
 586 Lurking in the darkness...
 587
 588 =head1 SEE ALSO
 589
 590 L<HTML::Mason>, L<FS>, L<RT>
 591
 592 =cut
 593
 594 1;