--- loncom/LONCAPA.pm 2006/12/10 23:06:13 1.21 +++ loncom/LONCAPA.pm 2008/11/17 13:22:01 1.25 @@ -1,7 +1,7 @@ # The LearningOnline Network # Base routines # -# $Id: LONCAPA.pm,v 1.21 2006/12/10 23:06:13 albertel Exp $ +# $Id: LONCAPA.pm,v 1.25 2008/11/17 13:22:01 jms Exp $ # # Copyright Michigan State University Board of Trustees # @@ -27,6 +27,42 @@ # ### +=head1 NAME + +Apache::LONCAPA + +LONCAPA - Basic routines + +=head1 SYNOPSIS + +Generally useful routines + +=head1 EXPORTED SUBROUTINES + +=over 4 + +=item * + +escape() : unpack non-word characters into CGI-compatible hex codes + +=item * + +unescape() : pack CGI-compatible hex codes into actual non-word ASCII character + +=item * + +add_get_param() : + Inputs: url (with or without exit GET from parameters), hash ref of + form name => value pairs + + Return: url with properly added the form name elements and values to the + the url doing proper escaping of the values and joining with ? or & + as needed + +=back + +=cut + package LONCAPA; use strict; @@ -43,6 +79,7 @@ use vars qw($match_domain $match_not_d $match_username $match_not_username $match_courseid $match_not_courseid $match_name + $match_lonid $match_handle $match_not_handle); require Exporter; @@ -54,11 +91,13 @@ our @EXPORT_OK = qw($match_domain $mat $match_username $match_not_username $match_courseid $match_not_courseid $match_name + $match_lonid $match_handle $match_not_handle); our %EXPORT_TAGS = ( 'match' =>[qw($match_domain $match_not_domain $match_username $match_not_username $match_courseid $match_not_courseid $match_name + $match_lonid $match_handle $match_not_handle)],); my %perlvar; @@ -110,8 +149,8 @@ sub clean_domain { return $domain; } -$match_username = $LONCAPA::username_re = qr{\w[\w\-.]+}; -$match_not_username = $LONCAPA::not_username_re = qr{[^\w\-.]+}; +$match_username = $LONCAPA::username_re = qr{\w[\w\-.@]+}; +$match_not_username = $LONCAPA::not_username_re = qr{[^\w\-.@]+}; sub clean_username { my ($username) = @_; $username =~ s/^\W+//; @@ -122,14 +161,22 @@ sub clean_username { $match_courseid = $LONCAPA::courseid_re = qr{\d[\w\-.]+}; $match_not_courseid = $LONCAPA::not_courseid_re = qr{[^\w\-.]+}; +sub clean_courseid { + my ($courseid) = @_; + $courseid =~ s/^\D+//; + $courseid =~ s/$match_not_courseid//g; + return $courseid; +} -$match_name = $LONCAPA::name = qr{$match_username|$match_courseid}; +$match_name = $LONCAPA::name_re = qr{$match_username|$match_courseid}; sub clean_name { my ($name) = @_; $name =~ s/$match_not_username//g; return $name; } +$match_lonid = $LONCAPA::lonid_re = qr{[\w\-.]+}; + sub split_courseid { my ($courseid) = @_; my ($domain,$coursenum) = @@ -137,8 +184,8 @@ sub split_courseid { return ($domain,$coursenum); } -$match_handle = $LONCAPA::handle_re = qr{[\w\-.]+}; -$match_not_handle = $LONCAPA::not_handle_re = qr{[^\w\-.]+}; +$match_handle = $LONCAPA::handle_re = qr{[\w\-.@]+}; +$match_not_handle = $LONCAPA::not_handle_re = qr{[^\w\-.@]+}; sub clean_handle { my ($handle) = @_; $handle =~ s/$match_not_handle//g; @@ -159,26 +206,32 @@ sub propath { #--------------------------------------------------------------- -# -# Manipulation of hash based databases (factoring out common code -# for later use as we refactor. -# -# Ties a domain level resource file to a hash. -# If requested a history entry is created in the associated hist file. -# -# Parameters: -# domain - Name of the domain in which the resource file lives. -# namespace - Name of the hash within that domain. -# how - How to tie the hash (e.g. GDBM_WRCREAT()). -# loghead - Optional parameter, if present a log entry is created -# in the associated history file and this is the first part -# of that entry. -# logtail - Goes along with loghead, The actual logentry is of the -# form $loghead::logtail. -# Returns: -# Reference to a hash bound to the db file or alternatively undef -# if the tie failed. -# + +=pod + +=item tie_domain_hash() + +Manipulation of hash based databases (factoring out common code +for later use as we refactor. + + Ties a domain level resource file to a hash. + If requested a history entry is created in the associated hist file. + + Parameters: + domain - Name of the domain in which the resource file lives. + namespace - Name of the hash within that domain. + how - How to tie the hash (e.g. GDBM_WRCREAT()). + loghead - Optional parameter, if present a log entry is created + in the associated history file and this is the first part + of that entry. + logtail - Goes along with loghead, The actual logentry is of the + form $loghead::logtail. +Returns: + Reference to a hash bound to the db file or alternatively undef + if the tie failed. + +=cut + sub tie_domain_hash { my ($domain,$namespace,$how,$loghead,$logtail) = @_; @@ -197,25 +250,31 @@ sub tie_domain_hash { sub untie_domain_hash { return &_locking_hash_untie(@_); } -# -# Ties a user's resource file to a hash. -# If necessary, an appropriate history -# log file entry is made as well. -# This sub factors out common code from the subs that manipulate -# the various gdbm files that keep keyword value pairs. -# Parameters: -# domain - Name of the domain the user is in. -# user - Name of the 'current user'. -# namespace - Namespace representing the file to tie. -# how - What the tie is done to (e.g. GDBM_WRCREAT(). -# loghead - Optional first part of log entry if there may be a -# history file. -# what - Optional tail of log entry if there may be a history -# file. -# Returns: -# hash to which the database is tied. It's up to the caller to untie. -# undef if the has could not be tied. -# + +=pod + +=item tie_user_hash() + + Ties a user's resource file to a hash. + If necessary, an appropriate history + log file entry is made as well. + This sub factors out common code from the subs that manipulate + the various gdbm files that keep keyword value pairs. +Parameters: + domain - Name of the domain the user is in. + user - Name of the 'current user'. + namespace - Namespace representing the file to tie. + how - What the tie is done to (e.g. GDBM_WRCREAT(). + loghead - Optional first part of log entry if there may be a + history file. + what - Optional tail of log entry if there may be a history + file. +Returns: + hash to which the database is tied. It's up to the caller to untie. + undef if the has could not be tied. + +=cut + sub tie_user_hash { my ($domain,$user,$namespace,$how,$loghead,$what) = @_; @@ -230,8 +289,14 @@ sub untie_user_hash { return &_locking_hash_untie(@_); } -# routines if you just have a filename -# return tied hashref or undef +=pod + +=item locking_hash_tie() + +routines if you just have a filename +return tied hashref or undef + +=cut sub locking_hash_tie { my ($filename,$how)=@_; @@ -405,36 +470,4 @@ BEGIN { __END__ -=pod - -=head1 NAME - -LONCAPA - Basic routines - -=head1 SYNOPSIS - -Generally useful routines - -=head1 EXPORTED SUBROUTINES - -=over 4 - -=item * - -escape() : unpack non-word characters into CGI-compatible hex codes - -=item * - -unescape() : pack CGI-compatible hex codes into actual non-word ASCII character -=item * - -add_get_param() : - Inputs: url (with or without exit GET from parameters), hash ref of - form name => value pairs - - Return: url with properly added the form name elements and values to the - the url doing proper escaping of the values and joining with ? or & - as needed - -=back