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