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