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