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