This is Info file pm.info, produced by Makeinfo version 1.68 from the input file bigpm.texi.  File: pm.info, Node: SyslogScan/Usage, Next: SyslogScan/WhereIs, Prev: SyslogScan/SyslogEntry, Up: Module List encapsulates the total volumes of mail broadcast, sent, and received through sendmail by a single user or group. **************************************************************************************************************** NAME ==== SyslogScan::Usage - encapsulates the total volumes of mail broadcast, sent, and received through sendmail by a single user or group. SyslogScan::Volume - encapsulates a number of messages along with a total number of bytes SYNOPSIS ======== # $summary is a SyslogScan::Summary object use SyslogScan::Usage; my $usage = $$summary{'john_doe@foo.com'}; $usage -> dump(); use SyslogScan::Volume; my $broadcastVolume = $usage -> getBroadcastVolume(); my $sendVolume = $usage -> getSendVolume(); my $receiveVolume = $usage -> getReceiveVolume(); print "John Doe sent $$sendVolume[0] messages with $$sendVolume[1] bytes\n"; DESCRIPTION =========== Broadcast, Send, and Receive ---------------------------- Volume of messages received has the obvious meaning. Volume of messages sent and volume of messages broadcast require more explanation. If I send out a message which has three recipients, then for the purposes of the SyslogScan modules, I am *broadcasting* the message once, but I am *sending* it three times. Usage methods ------------- new() method Creates a new, empty Usage object. addUsage() method and deepCopy() method # $usage1 is 4 messages of 100 bytes Received # $usage2 is 1 message of 35 bytes Received my $usageTotal = $usage1 -> deepCopy(); # $usageTotal is 4 messages of 100 bytes Received $usageTotal -> addUsage($usage2); # $usageTotal is 5 messages of 135 bytes Received Note that because we used deepCopy, *$usage1* is still 4 messages of 100 bytes. registerBroadcast, registerSend, registerReceive methods my $usage = new SyslogScan::Usage(); $usage -> registerSend(512); $usage -> registerSend(34); $usage -> registerBroadcast(34); # $usage is now 2 messages, 546 bytes Sent, # and 1 message, 34 bytes Broadcast getBroadcastVolume, getSendVolume, getReceiveVolume methods Returns deep copy of the applicable SyslogScan::Volume objects. static deepCopy method Returns deep copy of the whole SyslogScan::Usage object. static dump Returns a string containing (Message,Bytes) pairs for Broadcast, Send, and Receive volumes. Volume methods -------------- new() method Creates a new Volume object of 0 messages, 0 bytes. deepCopy() method Creates a new Volume object with the same number of messages and bytes as the current Volume object. addVolume(), addSize() methods addVolume() adds the volume of a second Volume object onto the volume of the current Volume object. addSize() adds on one message of the given size. use SyslogScan::Volume; my $volume1 = new SyslogScan::Volume(); $volume1 -> addSize(512); my $volume2 = $volume1 -> deepCopy(); # $volume2 is 1 message, 512 bytes $volume2 -> addSize(31); # $volume2 is 2 messages, 543 bytes $volume2 -> addVolume($volume1); # $volume2 is 3 messages, 1055 bytes $volume2 -> addVolume($volume2); # $volume2 is 6 messages, 2110 bytes getMessageCount, getByteCount Gets the number of messages and the total number of bytes, respectively. dump() Returns the string "getMessageCount(),getByteCount()" Volume internals ---------------- A Volume is simply a two-element array of ($messages, $bytes). $$volume[0] is the number of messages $$volume[1] is the number of bytes AUTHOR and COPYRIGHT ==================== The author (Rolf Harold Nelson) can currently be e-mailed as rolf@usa.healthnet.org. This code is Copyright (C) SatelLife, Inc. 1996. All rights reserved. This code is free software; you can redistribute it and/or modify it under the same terms as Perl itself. In no event shall SatelLife be liable to any party for direct, indirect, special, incidental, or consequential damages arising out of the use of this software and its documentation (including, but not limited to, lost profits) even if the authors have been advised of the possibility of such damage. SEE ALSO ======== *Note SyslogScan/Summary: SyslogScan/Summary,  File: pm.info, Node: SyslogScan/WhereIs, Next: TFTP, Prev: SyslogScan/Usage, Up: Module List return full path of syslog file where mail messages are logged ************************************************************** NAME ==== SyslogScan::WhereIs::guess - return full path of syslog file where mail messages are logged SYNOPSIS ======== my $syslogPath = new SyslogScan::Whereis::guess("/etc/syslog.conf"); DESCRIPTION =========== Scans a syslog configuration file to try to figure out where "mail.info" messages are sent. Default configuration file is "/etc/syslog.conf". Returns undef if the syslog file cannot be determined. BUGS ==== It might have been more elegant to return an array of syslog files; this would, as a bonus, permit multiple syslogs to be returned if mail messages go to more than one place. AUTHOR and COPYRIGHT ==================== The author (Rolf Harold Nelson) can currently be e-mailed as rolf@usa.healthnet.org. This code is Copyright (C) SatelLife, Inc. 1996. All rights reserved. This code is free software; you can redistribute it and/or modify it under the same terms as Perl itself. In no event shall SatelLife be liable to any party for direct, indirect, special, incidental, or consequential damages arising out of the use of this software and its documentation (including, but not limited to, lost profits) even if the authors have been advised of the possibility of such damage. SEE ALSO ======== *Note SyslogScan/DeliveryIterator: SyslogScan/DeliveryIterator,  File: pm.info, Node: TFTP, Next: TableMap, Prev: SyslogScan/WhereIs, Up: Module List TFTP Client class ***************** NAME ==== TFTP - TFTP Client class SYNOPSIS ======== use TFTP; $tftp = new TFTP("some.host.name"); $tftp->get("that.file"); $tftp->octet; $tftp->put("this.file"); $tftp->quit; DESCRIPTION =========== `TFTP' is a class implementing a simple TFTP client in Perl as described in RFC783. OVERVIEW ======== TFTP stands for Trivial File Transfer Protocol. CONSTRUCTOR =========== new (HOST [,OPTIONS]) This is the constructor for a new TFTP object. `HOST' is the name of the remote host to which a TFTP connection is required. OPTIONS are passed in a hash like fashion, using key and value pairs. Possible options are: Port - The port number to connect to on the remote machine for the TFTP connection Mode - Set the transfer mode [NETASCII, OCTET] (defaults to NETASCII) Timeout - Set the timeout value before retry (defaults to 2 sec) *MaxTimeout* - Set the maximum timeout value before retry (defaults to 8 sec) *Retries* - Set the number of retries (defaults to 3 with arithmetic backoff) METHODS ======= mode (TYPE) This method will set the mode to be used with the remote TFTP server to specify the type of data transfer. The return value is the previous value. netascii, ascii, octet, binary Synonyms for mode with the first argument set accordingly get ( REMOTE_FILE [, LOCAL_FILE ] ) Get `REMOTE_FILE' from the server and store locally. `LOCAL_FILE' may be a filename or a filehandle. If not specified the the file will be stored in the current directory with the same leafname as the remote file. Returns `LOCAL_FILE', or the generated local file name if `LOCAL_FILE' is not given. put ( LOCAL_FILE [, REMOTE_FILE ] ) Put a file on the remote server. `LOCAL_FILE' may be a name or a filehandle. If `LOCAL_FILE' is a filehandle then `REMOTE_FILE' must be specified. If `REMOTE_FILE' is not specified then the file will be stored in the current directory with the same leafname as `LOCAL_FILE'. Returns `REMOTE_FILE', or the generated remote filename if `REMOTE_FILE' is not given. quit Close the current socket and release any resources. A more complete way to release resources is to call 'undef $tftp;' on the session object. REPORTING BUGS ============== When reporting bugs/problems please include as much information as possible. It may be difficult for me to reproduce the problem as almost every setup is different. A small script which yields the problem will probably be of help. It would also be useful if this script was run with the extra options `debug =' 1> passed to the constructor, and the output sent with the bug report. If you cannot include a small script then please include a Debug trace from a run of your program which does yield the problem. AUTHOR ====== G. S. Marzot SEE ALSO ======== tftp(1), tftpd(8), RFC 783 http://info.internet.isi.edu:80/in-notes/rfc/files/rfc783.txt Copyright (c) 1998 G. S. Marzot. All rights reserved. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.  File: pm.info, Node: TableMap, Next: Taco, Prev: TFTP, Up: Module List Maps relational tables into hashes ********************************** NAME ==== TableMap - Maps relational tables into hashes SYNOPSIS ======== use DBI; $dbh=DBI->connect(...); use TableMap; $database=new TableMap::DB( dbh => $dbh, # DBI Database handler seq_mode => "ora", # Sequence handling mode # "ora": "select seqence.currval from dual"; # "pg" : "select sequence.last_value"; # db systems, which doesn't support sequences currently # doesn't supported (insert won't work) prepare_cached => 0, # Can use "prepare_cached" method of the DBI? # This causes problems for me, and that's why the # default is now 0. This param is not mandatory. ); # You can use connect hash to specify connect parameters directly. # In this case you doesn't need to specify "dbh" parameter: # $database=new TableMap::DB( # connect=> [$data_source, $username, $auth, \%attr], # seq_currval => ... # ); $company=$database->new_table ( table => "company", # Table name, mandatory key => "id", # Primary Key for the table seq => "seq_company",# Sequence name for key field generation. # Mandatory only if "insert" is in use ); # $database->new_table(...) # is the same as # new TableMap ( db => $database, ... ) $user =$database->new_table ( table => "users", key => "id", seq => "seq_users", ref => { company_id => [ $company, "user" ] }, # This can be used for connecting tables. # This is similar to the SQL phrase: # # .. company_id int references company (id), # # only the key field can be referenced. ); %company_14_users= % {$company->{14}->user }; # All user IDs keys %$user; # Sets Company #14 Data: $company_14 = $company->{14}; $company_14->{tax_num} = "123456"; $company_14->{phone1} = "+42456245546"; $company_14->write; # Wrong example: # $company->{14}->{tax_num} = "123456" # $company->{14}->write; # This doesn't work, because it always create a new Row object, # and the cache is stored per object. # Select a sub-relation $table=$user->select("company_id = ?",$id); # Select with constraint $user->constraint( company_id => $id ); # New record $id=$company->new( { name=>"abc", phone1=>"30/123567", mobile=>"20/1234" } ); if ($id) { print "Id: $id\n"; } else { print "Insert failed: "; }; # Delete record delete $company->{13}; %{ $company->{13} }=(); DESCRIPTION =========== This class is designed for mapping a table into a perl hash, which has keys (these are the primary keys of the table), and the values are the rows, represented by a hash. Basic Usage ----------- You can create TableMap objects for tables. You must specify a parameter hash to the constructor, which has the following keys: db This is a reference to a TableMap::DB module. Normally you create a new TableMap object by the method of the "new_table" of a TableMap::DB instance, then you may not specify this. table Specifies the table name key Specifies the primary key. This must be specified, so if you don't have primary keys in your table, you cannot use the TableMap (for the whole table. You can use it for a subset of rows specified by the "constraint" param). seq If you want to use "insert" with self-incremental keys, you must specify this. Database servers, which doesn't implement sequences (mySQL) currently not supported. ref Creating a 1:N reference. The value is a hash reference, where the keys are database fields, and the values contains the reference information in an array reference: ref => { field1 => [ $table1, "function1" ], field2 => [ $table2, "function2" ], }; In the example above you can use the reference field (company_id) from the "user" table to query the company in which the user work: $company_name = $user->{17}->company_id->{name}. function1 is the name of the function, which can be used for the back-reference, eg. can be used to determine the user-ids in one company: @user_ids= keys %{ $company->{45}->users }. "users" is the function name in this example. where Specifies a "where" condition for selecting id-s, so you can select a subset of keys with this. Also available with the "search" function: @user_ids= keys %{ $table->search("age > 25") }; or $table=new TableMap (table => "table", where => "age > 25"); @user_ids=keys %$table; constraint This is similar to "select", but it can be used only for equality test. The main advantage is that it can be used for deletion and insertion. If you insert something into a table, which has constraint parameter, all the values in the constraint hash is set in the new record. This constraint is used internally, when somebody creates a back reference by a back-reference function. References ---------- There is two kind of reference in this module. All two are set up by "ref" parameter in the table. If you use a "ref" parameter, then the "back_ref" is automatically created in the other table (if not already exists). ref $user->company_id gives a TableMap::Row record, which is a ROW in the company table. Each hash keys are field names. back_ref $company->users gives a TableMap object, which is a COLLECTION of rows (represented by a hash), which gives back the employees of the companies. (you can use "keys ..." expression for the ids). Caching ------- All the sql queries are cached in this module. This must be rethink, because sometimes it is not the best solution. I want some extra parameter for caching in the newer versions. Now all the query results are cached for 10 seconds. The Cache object is $TableMap::cache, and it can be invalidated by the $TableMap::cache->invalidate_cache call. The cache is hierarchical (it is stored in tree structure). For more information on the cache you can see the source code. Performance ----------- This module is NOT the most efficient method for getting data from the database. It is written to avoid endless sql-query-typing with minimal performance loss. The module uses two kind of sql queries: select key from table This is used for querying all the keys from a table. This can be affected by the "constraint" and the "where" parameter. select * from table where id=1234 This is used for querying all the fields of one row. This can be affected by the "constraint" parameter, but not thw "where". Sometimes querying the whole table is more effective, (when you have enough memory), but currently it is only a planned parameter. TODO ---- * This module is now usable for one purpose. I have profiled it, and I've found that the "read_data" function is the most time-consuming. This must be handled by re-organizing the cache. * I want to add a parameter for setting for the caching mode. Sometimes no caching is allowed, but sometimes te full table must be cached for good performance. * Cahce reorganization is needed, because reaching a cached data is quite slow. COPYRIGHT ========= Copyrigh (c) 2000 Balázs Szabó (dLux) All rights reserved. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself. AUTHOR ====== dLux  File: pm.info, Node: Taco, Next: Taco/Arg, Prev: TableMap, Up: Module List Dynamic web page system *********************** NAME ==== Taco - Dynamic web page system SYNOPSIS ======== # In a dynamic document [[$user_id]]s web page Here are your favorite foods:
[[&list(driver=foods for_user=[[$user_id]] display_template=food_template)]] # For serving Taco web pages, put in httpd.conf PerlModule Apache::Taco SetHandler perl-script PerlHandler Apache::Taco # For parsing stand-alone files, type at Unix prompt parse_file.pl [-s service] [-q query_string] filename (not ready yet, sorry) DESCRIPTION =========== Taco is a software tool which facilitates the creation of dynamic web pages. It's meant to run under the Apache web server, using the mod_perl extension. A Taco page is just like a regular HTML page, with one important addition: a Taco page can contain Taco tags. When a user requests a Taco page, the Taco software finds all the Taco tags on the page and replaces them with the appropriate text. This text can come from a database, from a discussion group, or from the query string, among other places. In fact, Taco itself doesn't define the functions you can have in a web page. Rather, the functionality is encapsulated in modules, which can be plugged into Taco. You can write your own modules or use common ones that are already written. The most basic module functionality is in the Taco::Generic.pm module, which is distributed with the main Taco distribution. All modules, including Taco::Generic, are sub-classes of Taco::Module. For more documentation, please see the other modules in this distribution. See Taco::Module for a description of the syntax of the tags (how to use them in a web page), or instructions on how to write your own Taco module. See any Taco module's documentation for a description of the specific tags it defines. DOCUMENTATION ============= The documentation for Taco is spread out among several modules. Here is a summary of what each module does and what its documentation covers: Apache::Taco This is the PerlHandler to use with mod_perl. Here you'll find information on how to configure a mod_perl-enabled server to load Taco pages. Taco::Arg This module implements the ArgTable and ArgLayer objects which hold all the parameters in the query string, the POSTed form contents, arguments passed to functions in [[tags]], parameters set using the [[&set]] tag, and so on. Taco::Template This module controls the parsing and output of Taco templates. Templates are searched for [[tags]], and each tag is passed to the Taco::Dispatcher module, which decides which Taco module (e.g. Taco::Generic) will handle the tag. Taco::Module This is a base class for Taco extension modules. An extension module (Taco::Generic is an example) can supply more Taco tags for use in templates. Taco::ServiceRegistry A Taco service is basically a set of configuration information. The ServiceRegistry file contains definitional information about the various services. To add a service to Taco, add an entry in the ServiceRegistry file. Taco::Dispatcher This module provides the glue between a Taco "service" and the Taco modules it uses. It also has routines that parse the insides of Taco [[tags]], so the definitions of Taco syntaxes are given here. Taco::Generic This is a fairly generic Taco extension module. It provides several tags, such as [[&set]] (puts an entry in the global ArgTable), [[&if]] (a conditional statement), [[&mark_me]] (useful for checking checkboxes and radio buttons and selecting choices in a