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_event;
 184   use FS::part_event_condition;
 185   use FS::part_pkg;
 186   use FS::part_referral;
 187   use FS::part_svc;
 188   use FS::part_svc_router;
 189   use FS::part_virtual_field;
 190   use FS::pay_batch;
 191   use FS::pkg_svc;
 192   use FS::port;
 193   use FS::queue qw(joblisting);
 194   use FS::raddb;
 195   use FS::session;
 196   use FS::svc_acct;
 197   use FS::svc_acct_pop qw(popselector);
 198   use FS::acct_rt_transaction;
 199   use FS::svc_domain;
 200   use FS::svc_forward;
 201   use FS::svc_www;
 202   use FS::router;
 203   use FS::addr_block;
 204   use FS::svc_broadband;
 205   use FS::svc_external;
 206   use FS::type_pkgs;
 207   use FS::part_export;
 208   use FS::part_export_option;
 209   use FS::export_svc;
 210   use FS::export_device;
 211   use FS::msgcat;
 212   use FS::rate;
 213   use FS::rate_region;
 214   use FS::rate_prefix;
 215   use FS::rate_detail;
 216   use FS::usage_class;
 217   use FS::payment_gateway;
 218   use FS::agent_payment_gateway;
 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::agent_currency;
 346   use FS::currency_exchange;
 347   use FS::part_pkg_currency;
 348   use FS::cust_payby;
 349   use FS::vend_main;
 350   use FS::vend_class;
 351   use FS::vend_bill;
 352   use FS::vend_pay;
 353   use FS::vend_bill_pay;
 354   use FS::sales_pkg_class;
 355   use FS::svc_alarm;
 356   use FS::cable_model;
 357   use FS::invoice_mode;
 358   use FS::invoice_conf;
 359   use FS::cable_provider;
 360   use FS::cust_credit_void;
 361   use FS::discount_class;
 362   use FS::alarm_system;
 363   use FS::alarm_type;
 364   use FS::alarm_station;
 365   use FS::addr_range;
 366   use FS::svc_conferencing;
 367   use FS::conferencing_type;
 368   use FS::conferencing_quality;
 369   use FS::svc_video;
 370   use FS::part_pkg_usageprice;
 371   use FS::cust_pkg_usageprice;
 372   use FS::pbx_extension;
 373   use FS::pbx_device;
 374   use FS::extension_device;
 375   use FS::cust_main_credit_limit;
 376   use FS::cust_event_fee;
 377   use FS::part_fee;
 378   use FS::cust_bill_pkg_fee;
 379   use FS::part_fee_msgcat;
 380   use FS::part_fee_usage;
 381   use FS::sched_item;
 382   use FS::sched_avail;
 383   use FS::export_batch;
 384   use FS::export_batch_item;
 385   use FS::part_pkg_fcc_option;
 386   use FS::state;
 387   use FS::state;
 388   use FS::queue_stat;
 389   use FS::deploy_zone;
 390   use FS::deploy_zone_block;
 391   use FS::deploy_zone_vertex;
 392   use FS::TaxEngine;
 393   use FS::tax_status;
 394   use FS::circuit_type;
 395   use FS::circuit_provider;
 396   use FS::circuit_termination;
 397   use FS::svc_circuit;
 398   use FS::cust_credit_source_bill_pkg;
 399   use FS::prospect_contact;
 400   use FS::cust_contact;
 401   # Sammath Naur
 402
 403   if ( $FS::Mason::addl_handler_use ) {
 404     eval $FS::Mason::addl_handler_use;
 405     die $@ if $@;
 406   }
 407
 408   if ( %%%RT_ENABLED%%% ) {
 409     eval '
 410       use lib ( "/opt/rt3/local/lib", "/opt/rt3/lib" );
 411       use vars qw($Nobody $SystemUser);
 412       use RT;
 413       use RT::Util;
 414       use RT::Tickets;
 415       use RT::Transactions;
 416       use RT::Users;
 417       use RT::CurrentUser;
 418       use RT::Templates;
 419       use RT::Queues;
 420       use RT::ScripActions;
 421       use RT::ScripConditions;
 422       use RT::Scrips;
 423       use RT::Groups;
 424       use RT::GroupMembers;
 425       use RT::CustomFields;
 426       use RT::CustomFieldValues;
 427       use RT::ObjectCustomFieldValues;
 428
 429       #blah.  manually updated from RT::Interface::Web::Handler
 430       use RT::Interface::Web;
 431       use MIME::Entity;
 432       use Text::Wrapper;
 433       use Time::ParseDate;
 434       use Time::HiRes;
 435       use HTML::Scrubber;
 436
 437       #blah.  not even in RT::Interface::Web::Handler, just in
 438       #html/NoAuth/css/dhandler and rt-test-dependencies.  ask for it here
 439       #to throw a real error instead of just a mysterious unstyled RT
 440       use CSS::Squish 0.06;
 441
 442       use RT::Interface::Web::Request;
 443
 444       #another undeclared web UI dep (for ticket links graph)
 445       use IPC::Run::SafeHandles;
 446
 447       #slow, unreliable, segfaults and is optional
 448       #see rt/html/Ticket/Elements/ShowTransactionAttachments
 449       #use Text::Quoted;
 450
 451       #?#use File::Path qw( rmtree );
 452       #?#use File::Glob qw( bsd_glob );
 453       #?#use File::Spec::Unix;
 454
 455     ';
 456     die $@ if $@;
 457   }
 458
 459   *CGI::redirect = sub {
 460     my $self = shift;
 461     my $cookie = '';
 462     if ( $_[0] eq '-cookie' ) { #this isn't actually used at the moment
 463       (my $x, $cookie) = (shift, shift);
 464       $HTML::Mason::r->err_headers_out->add( 'Set-cookie' => $cookie );
 465     }
 466     my $location = shift;
 467
 468     use vars qw($m);
 469
 470     # false laziness w/below
 471     if ( @DBIx::Profile::ISA ) {
 472
 473       if ( $FS::CurrentUser::CurrentUser->option('show_db_profile') ) {
 474
 475         #profiling redirect
 476
 477         my $page =
 478           qq!<HTML><BODY>Redirect to <A HREF="$location">$location</A>!.
 479           '<BR><BR><PRE>'.
 480             ( UNIVERSAL::can(dbh, 'sprintProfile')
 481                 ? encode_entities(dbh->sprintProfile())
 482                 : 'DBIx::Profile missing sprintProfile method;'.
 483                   'unpatched or too old?'                        ).
 484           #"\n\n". &sprintAutoProfile().  '</PRE>'.
 485           "\n\n".                         '</PRE>'.
 486           '</BODY></HTML>';
 487
 488
 489         dbh->{'private_profile'} = {};
 490         return $page;
 491
 492       } else {
 493
 494         #clear db profile, but normal redirect
 495         dbh->{'private_profile'} = {};
 496         $m->redirect($location);
 497         '';
 498
 499       }
 500
 501     } else { #normal redirect
 502
 503       $m->redirect($location);
 504       '';
 505
 506     }
 507
 508   };
 509
 510   sub include {
 511     use vars qw($m);
 512     #carp #should just switch to <& &> syntax
 513     $m->scomp(@_);
 514   }
 515
 516   sub errorpage {
 517     use vars qw($m);
 518     $m->comp('/elements/errorpage.html', @_);
 519   }
 520
 521   sub errorpage_popup {
 522     use vars qw($m);
 523     $m->comp('/elements/errorpage-popup.html', @_);
 524   }
 525
 526   sub redirect {
 527     my( $location ) = @_;
 528     use vars qw($m);
 529     $m->clear_buffer;
 530     #false laziness w/above
 531     if ( @DBIx::Profile::ISA ) {
 532
 533       if ( $FS::CurrentUser::CurrentUser->option('show_db_profile') ) {
 534
 535         #profiling redirect
 536
 537         $m->print(
 538           qq!<HTML><BODY>Redirect to <A HREF="$location">$location</A>!.
 539           '<BR><BR><PRE>'.
 540             ( UNIVERSAL::can(dbh, 'sprintProfile')
 541                 ? encode_entities(dbh->sprintProfile())
 542                 : 'DBIx::Profile missing sprintProfile method;'.
 543                   'unpatched or too old?'                        ).
 544           #"\n\n". &sprintAutoProfile().  '</PRE>'.
 545           "\n\n".                         '</PRE>'.
 546           '</BODY></HTML>'
 547         );
 548
 549         dbh->{'private_profile'} = {};
 550
 551       } else {
 552
 553         #clear db profile, but normal redirect
 554         dbh->{'private_profile'} = {};
 555         $m->redirect($location);
 556
 557       }
 558
 559     } else { #normal redirect
 560
 561       $m->redirect($location);
 562
 563     }
 564
 565   }
 566
 567 } # end package HTML::Mason::Commands;
 568
 569 =head1 SUBROUTINE
 570
 571 =over 4
 572
 573 =item mason_interps [ MODE [ OPTION => VALUE ... ] ]
 574
 575 Returns a list consisting of two HTML::Mason::Interp objects, the first for
 576 Freeside pages, and the second for RT pages.
 577
 578 MODE can be 'apache' or 'standalone'.  If not specified, defaults to 'apache'.
 579
 580 Options and values can be passed following mode.  Currently available options
 581 are:
 582
 583 I<outbuf> should be set to a scalar reference in standalone mode.
 584
 585 =cut
 586
 587 my %defang_opts = ( attribs_to_callback => ['src'], attribs_callback => sub { 1 });
 588
 589 sub mason_interps {
 590   my $mode = shift || 'apache';
 591   my %opt = @_;
 592
 593   #my $request_class = 'HTML::Mason::Request'.
 594                       #( $mode eq 'apache' ? '::ApacheHandler' : '' );
 595   my $request_class = $mode eq 'standalone' ? 'FS::Mason::StandaloneRequest'
 596                                             : 'FS::Mason::Request';
 597
 598   #not entirely sure it belongs here, but what the hey
 599   if ( %%%RT_ENABLED%%% && $mode ne 'standalone' ) {
 600     RT::LoadConfig();
 601   }
 602
 603   my $fs_comp_root = '%%%FREESIDE_DOCUMENT_ROOT%%%';
 604
 605   my %interp = (
 606     request_class        => $request_class,
 607     data_dir             => '%%%MASONDATA%%%',
 608     error_mode           => 'output',
 609     error_format         => 'html',
 610     ignore_warnings_expr => '.',
 611   );
 612
 613   $interp{out_method} = $opt{outbuf} if $mode eq 'standalone' && $opt{outbuf};
 614
 615   my $html_defang = new HTML::Defang (%defang_opts);
 616
 617   #false laziness w/ FS::Maketext js_mt
 618   my $js_string_sub = sub {
 619     #${$_[0]} =~ s/(['\\\n])/'\\'.($1 eq "\n" ? 'n' : $1)/ge;
 620     ${$_[0]} =~ s/(['\\])/\\$1/g;
 621     ${$_[0]} =~ s/\r/\\r/g;
 622     ${$_[0]} =~ s/\n/\\n/g;
 623     # prevent premature termination of the script
 624     ${$_[0]} =~ s[</script>][<\\/script>]ig;
 625     ${$_[0]} = "'". ${$_[0]}. "'";
 626   };
 627
 628   my $defang_sub = sub {
 629     ${$_[0]} = $html_defang->defang(${$_[0]});
 630   };
 631
 632   my $fs_interp = new HTML::Mason::Interp (
 633     %interp,
 634     comp_root    => $fs_comp_root,
 635     escape_flags => { 'js_string'   => $js_string_sub,
 636                       'defang'      => $defang_sub,
 637                     },
 638     compiler     => HTML::Mason::Compiler::ToObject->new(
 639                       allow_globals        => [qw(%session)],
 640                     ),
 641   );
 642
 643   my $rt_interp = new HTML::Mason::Interp (
 644     %interp,
 645     comp_root    => [
 646                       [ 'rt'       => '%%%FREESIDE_DOCUMENT_ROOT%%%/rt' ],
 647                       [ 'freeside' => '%%%FREESIDE_DOCUMENT_ROOT%%%'    ],
 648                     ],
 649     escape_flags => { 'h'         => \&RT::Interface::Web::EscapeUTF8,
 650                       'u'         => \&RT::Interface::Web::EscapeURI,
 651                       'j'         => \&RT::Interface::Web::EscapeJS,
 652                       'js_string' => $js_string_sub,
 653                     },
 654     compiler     => HTML::Mason::Compiler::ToObject->new(
 655                       default_escape_flags => 'h',
 656                       allow_globals        => [qw(%session $DECODED_ARGS)],
 657                     ),
 658   );
 659
 660   ( $fs_interp, $rt_interp );
 661
 662 }
 663
 664 =back
 665
 666 =head1 BUGS
 667
 668 Lurking in the darkness...
 669
 670 =head1 SEE ALSO
 671
 672 L<HTML::Mason>, L<FS>, L<RT>
 673
 674 =cut
 675
 676 1;