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   # Sammath Naur
 383
 384   if ( $FS::Mason::addl_handler_use ) {
 385     eval $FS::Mason::addl_handler_use;
 386     die $@ if $@;
 387   }
 388
 389   if ( %%%RT_ENABLED%%% ) {
 390     eval '
 391       use lib ( "/opt/rt3/local/lib", "/opt/rt3/lib" );
 392       use vars qw($Nobody $SystemUser);
 393       use RT;
 394       use RT::Util;
 395       use RT::Tickets;
 396       use RT::Transactions;
 397       use RT::Users;
 398       use RT::CurrentUser;
 399       use RT::Templates;
 400       use RT::Queues;
 401       use RT::ScripActions;
 402       use RT::ScripConditions;
 403       use RT::Scrips;
 404       use RT::Groups;
 405       use RT::GroupMembers;
 406       use RT::CustomFields;
 407       use RT::CustomFieldValues;
 408       use RT::ObjectCustomFieldValues;
 409
 410       #blah.  manually updated from RT::Interface::Web::Handler
 411       use RT::Interface::Web;
 412       use MIME::Entity;
 413       use Text::Wrapper;
 414       use Time::ParseDate;
 415       use Time::HiRes;
 416       use HTML::Scrubber;
 417
 418       #blah.  not even in RT::Interface::Web::Handler, just in
 419       #html/NoAuth/css/dhandler and rt-test-dependencies.  ask for it here
 420       #to throw a real error instead of just a mysterious unstyled RT
 421       use CSS::Squish 0.06;
 422
 423       use RT::Interface::Web::Request;
 424
 425       #another undeclared web UI dep (for ticket links graph)
 426       use IPC::Run::SafeHandles;
 427
 428       #slow, unreliable, segfaults and is optional
 429       #see rt/html/Ticket/Elements/ShowTransactionAttachments
 430       #use Text::Quoted;
 431
 432       #?#use File::Path qw( rmtree );
 433       #?#use File::Glob qw( bsd_glob );
 434       #?#use File::Spec::Unix;
 435
 436     ';
 437     die $@ if $@;
 438   }
 439
 440   *CGI::redirect = sub {
 441     my $self = shift;
 442     my $cookie = '';
 443     if ( $_[0] eq '-cookie' ) { #this isn't actually used at the moment
 444       (my $x, $cookie) = (shift, shift);
 445       $HTML::Mason::r->err_headers_out->add( 'Set-cookie' => $cookie );
 446     }
 447     my $location = shift;
 448
 449     use vars qw($m);
 450
 451     # false laziness w/below
 452     if ( @DBIx::Profile::ISA ) {
 453
 454       if ( $FS::CurrentUser::CurrentUser->option('show_db_profile') ) {
 455
 456         #profiling redirect
 457
 458         my $page =
 459           qq!<HTML><BODY>Redirect to <A HREF="$location">$location</A>!.
 460           '<BR><BR><PRE>'.
 461             ( UNIVERSAL::can(dbh, 'sprintProfile')
 462                 ? encode_entities(dbh->sprintProfile())
 463                 : 'DBIx::Profile missing sprintProfile method;'.
 464                   'unpatched or too old?'                        ).
 465           #"\n\n". &sprintAutoProfile().  '</PRE>'.
 466           "\n\n".                         '</PRE>'.
 467           '</BODY></HTML>';
 468
 469
 470         dbh->{'private_profile'} = {};
 471         return $page;
 472
 473       } else {
 474
 475         #clear db profile, but normal redirect
 476         dbh->{'private_profile'} = {};
 477         $m->redirect($location);
 478         '';
 479
 480       }
 481
 482     } else { #normal redirect
 483
 484       $m->redirect($location);
 485       '';
 486
 487     }
 488
 489   };
 490
 491   sub include {
 492     use vars qw($m);
 493     #carp #should just switch to <& &> syntax
 494     $m->scomp(@_);
 495   }
 496
 497   sub errorpage {
 498     use vars qw($m);
 499     $m->comp('/elements/errorpage.html', @_);
 500   }
 501
 502   sub errorpage_popup {
 503     use vars qw($m);
 504     $m->comp('/elements/errorpage-popup.html', @_);
 505   }
 506
 507   sub redirect {
 508     my( $location ) = @_;
 509     use vars qw($m);
 510     $m->clear_buffer;
 511     #false laziness w/above
 512     if ( @DBIx::Profile::ISA ) {
 513
 514       if ( $FS::CurrentUser::CurrentUser->option('show_db_profile') ) {
 515
 516         #profiling redirect
 517
 518         $m->print(
 519           qq!<HTML><BODY>Redirect to <A HREF="$location">$location</A>!.
 520           '<BR><BR><PRE>'.
 521             ( UNIVERSAL::can(dbh, 'sprintProfile')
 522                 ? encode_entities(dbh->sprintProfile())
 523                 : 'DBIx::Profile missing sprintProfile method;'.
 524                   'unpatched or too old?'                        ).
 525           #"\n\n". &sprintAutoProfile().  '</PRE>'.
 526           "\n\n".                         '</PRE>'.
 527           '</BODY></HTML>'
 528         );
 529
 530         dbh->{'private_profile'} = {};
 531
 532       } else {
 533
 534         #clear db profile, but normal redirect
 535         dbh->{'private_profile'} = {};
 536         $m->redirect($location);
 537
 538       }
 539
 540     } else { #normal redirect
 541
 542       $m->redirect($location);
 543
 544     }
 545
 546   }
 547
 548 } # end package HTML::Mason::Commands;
 549
 550 =head1 SUBROUTINE
 551
 552 =over 4
 553
 554 =item mason_interps [ MODE [ OPTION => VALUE ... ] ]
 555
 556 Returns a list consisting of two HTML::Mason::Interp objects, the first for
 557 Freeside pages, and the second for RT pages.
 558
 559 MODE can be 'apache' or 'standalone'.  If not specified, defaults to 'apache'.
 560
 561 Options and values can be passed following mode.  Currently available options
 562 are:
 563
 564 I<outbuf> should be set to a scalar reference in standalone mode.
 565
 566 =cut
 567
 568 my %defang_opts = ( attribs_to_callback => ['src'], attribs_callback => sub { 1 });
 569
 570 sub mason_interps {
 571   my $mode = shift || 'apache';
 572   my %opt = @_;
 573
 574   #my $request_class = 'HTML::Mason::Request'.
 575                       #( $mode eq 'apache' ? '::ApacheHandler' : '' );
 576   my $request_class = $mode eq 'standalone' ? 'FS::Mason::StandaloneRequest'
 577                                             : 'FS::Mason::Request';
 578
 579   #not entirely sure it belongs here, but what the hey
 580   if ( %%%RT_ENABLED%%% && $mode ne 'standalone' ) {
 581     RT::LoadConfig();
 582   }
 583
 584   my $fs_comp_root = '%%%FREESIDE_DOCUMENT_ROOT%%%';
 585
 586   my %interp = (
 587     request_class        => $request_class,
 588     data_dir             => '%%%MASONDATA%%%',
 589     error_mode           => 'output',
 590     error_format         => 'html',
 591     ignore_warnings_expr => '.',
 592   );
 593
 594   $interp{out_method} = $opt{outbuf} if $mode eq 'standalone' && $opt{outbuf};
 595
 596   my $html_defang = new HTML::Defang (%defang_opts);
 597
 598   #false laziness w/ FS::Maketext js_mt
 599   my $js_string_sub = sub {
 600     #${$_[0]} =~ s/(['\\\n])/'\\'.($1 eq "\n" ? 'n' : $1)/ge;
 601     ${$_[0]} =~ s/(['\\])/\\$1/g;
 602     ${$_[0]} =~ s/\r/\\r/g;
 603     ${$_[0]} =~ s/\n/\\n/g;
 604     # prevent premature termination of the script
 605     ${$_[0]} =~ s[</script>][<\\/script>]ig;
 606     ${$_[0]} = "'". ${$_[0]}. "'";
 607   };
 608
 609   my $defang_sub = sub {
 610     ${$_[0]} = $html_defang->defang(${$_[0]});
 611   };
 612
 613   my $fs_interp = new HTML::Mason::Interp (
 614     %interp,
 615     comp_root    => $fs_comp_root,
 616     escape_flags => { 'js_string'   => $js_string_sub,
 617                       'defang'      => $defang_sub,
 618                     },
 619     compiler     => HTML::Mason::Compiler::ToObject->new(
 620                       allow_globals        => [qw(%session)],
 621                     ),
 622   );
 623
 624   my $rt_interp = new HTML::Mason::Interp (
 625     %interp,
 626     comp_root    => [
 627                       [ 'rt'       => '%%%FREESIDE_DOCUMENT_ROOT%%%/rt' ],
 628                       [ 'freeside' => '%%%FREESIDE_DOCUMENT_ROOT%%%'    ],
 629                     ],
 630     escape_flags => { 'h'         => \&RT::Interface::Web::EscapeUTF8,
 631                       'u'         => \&RT::Interface::Web::EscapeURI,
 632                       'j'         => \&RT::Interface::Web::EscapeJS,
 633                       'js_string' => $js_string_sub,
 634                     },
 635     compiler     => HTML::Mason::Compiler::ToObject->new(
 636                       default_escape_flags => 'h',
 637                       allow_globals        => [qw(%session $DECODED_ARGS)],
 638                     ),
 639   );
 640
 641   ( $fs_interp, $rt_interp );
 642
 643 }
 644
 645 =back
 646
 647 =head1 BUGS
 648
 649 Lurking in the darkness...
 650
 651 =head1 SEE ALSO
 652
 653 L<HTML::Mason>, L<FS>, L<RT>
 654
 655 =cut
 656
 657 1;