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