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