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