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