[LON-CAPA-cvs] cvs: modules /ehlerst/homescreen feeds.rights loncapa_apache.conf loncommon.pm lonfeedback.pm lonfeeds.pm lonroles.pm

ehlerst ehlerst@source.lon-capa.org
Sat, 19 Mar 2011 15:47:13 -0000


This is a MIME encoded message

--ehlerst1300549633
Content-Type: text/plain

ehlerst		Sat Mar 19 15:47:13 2011 EDT

  Added files:                 
    /modules/ehlerst/homescreen	feeds.rights loncapa_apache.conf 
                               	loncommon.pm lonfeedback.pm lonfeeds.pm 
                               	lonroles.pm 
  Log:
  New version of the roles screen regarding bug 5932.
  
  
--ehlerst1300549633
Content-Type: text/plain
Content-Disposition: attachment; filename="ehlerst-20110319154713.txt"


Index: modules/ehlerst/homescreen/feeds.rights
+++ modules/ehlerst/homescreen/feeds.rights
discussion:bre
problem:bre
document:bre
handgrading:mgr
bomb:opa

Index: modules/ehlerst/homescreen/loncapa_apache.conf
+++ modules/ehlerst/homescreen/loncapa_apache.conf
##
## loncapa_apache.conf -- Apache HTTP LON-CAPA configuration file
##
## $Id: loncapa_apache.conf,v 1.1 2011/03/19 15:47:12 ehlerst Exp $
##

#
# LON-CAPA Section (extensions to httpd.conf daemon configuration)
#
# ================================================================ DocumentRoot

DocumentRoot "/home/httpd/html"

# ======================================================================== User

User www
Group www

# ======================================================= Shared Object Modules

LoadModule perl_module       modules/libperl.so
<IfDefine !MODPERL2>
AddModule mod_perl.c
</IfDefine>

<IfDefine MODPERL2>
PerlSetVar	MODPERL2	1
</IfDefine>
# =============================================================== Miscellaneous

ServerAdmin korte@lite.msu.edu
ExtendedStatus On
#
# LON-CAPA Section (extensions to srm.conf name space servicing)
#
# ===================================================================== Aliases

Alias /zipspool/ /home/httpd/zipspool/
Alias /prtspool/ /home/httpd/prtspool/
Alias /captchaspool/ /home/httpd/captchaspool/
ScriptAlias /cgi-bin/ "/home/httpd/cgi-bin/"

# ================================================================= Directories

# ------------------------------------------------------------- Access Handlers

PerlTransHandler	Apache::lontrans
PerlCleanupHandler	Apache::lonacc::cleanup

PerlAuthenHandler Apache::checkauthen
PerlSetVar lonOtherAuthen no

#PerlWarn On
<LocationMatch "^/+res/adm/pages/[^/]+\.(gif|png)$">
PerlAuthenHandler	'sub { return OK }' 
</LocationMatch>

# Send proper expires header to avoid unnecessary HTTP request for static content
<LocationMatch "^(/adm/lonIcons|/adm/jQuery|/adm/jsMath|/res/adm/pages|/ckeditor)">
        ExpiresActive On
        ExpiresDefault "access plus 12 hours"
        Header set Cache-Control "public, no-transform"
</LocationMatch>

<LocationMatch "^/+res.*">

AuthType LONCAPA
Require valid-user

PerlAccessHandler      Apache::publiccheck
PerlAuthzHandler       Apache::lonacc
PerlHeaderParserHandler Apache::lonrep
ErrorDocument     403 /adm/login
ErrorDocument     404 /adm/notfound.html
ErrorDocument     406 /adm/roles
ErrorDocument	  500 /adm/errorhandler
</LocationMatch>


<LocationMatch "/.*">
</LocationMatch>

<LocationMatch "^/+adm/lonFeeds/.*\.atom">
AuthType          LONCAPA
Require           valid-user
PerlAuthzHandler  Apache::lonacc
SetHandler        perl-script
PerlHandler       Apache::lonfeeds
ErrorDocument     403 /adm/login
ErrorDocument     404 /adm/notfound.html
ErrorDocument     406 /adm/unauthorized
ErrorDocument     500 /adm/errorhandler
</LocationMatch>

<LocationMatch "^/+enc.*">
SetHandler perl-script
PerlHandler       Apache::lonencurl
ErrorDocument     403 /adm/login
ErrorDocument     404 /adm/notfound.html
ErrorDocument     406 /adm/roles
ErrorDocument	  500 /adm/errorhandler
</LocationMatch>

<Location /adm/portfolio>
AuthType LONCAPA
Require valid-user
PerlAuthzHandler Apache::lonacc
SetHandler perl-script
PerlHandler Apache::portfolio
</Location>

<Location /adm/coursegrp_portfolio>
AuthType LONCAPA
Require valid-user
PerlAuthzHandler Apache::lonacc
SetHandler perl-script
PerlHandler Apache::portfolio
</Location>

<Location /adm/pdfupload>
AuthType LONCAPA
Require valid-user
PerlAuthzHandler Apache::lonacc
SetHandler perl-script
PerlHandler             Apache::lonpdfupload
ErrorDocument     403 /adm/login
ErrorDocument     404 /adm/notfound.html
ErrorDocument     406 /adm/roles
ErrorDocument     500 /adm/errorhandler
</Location>

<LocationMatch "^/+userfiles.*">
PerlAccessHandler       Apache::lontokacc
PerlCleanupHandler	Apache::lontokacc::removefile
PerlCleanupHandler	Apache::lonacc::cleanup
</LocationMatch>

<LocationMatch "^/+uploaded.*">
AuthType LONCAPA
Require valid-user
PerlAuthzHandler	Apache::lonacc
PerlHandler 		Apache::londatecheck
PerlHandler  		Apache::lonipcheck
PerlHeaderParserHandler Apache::lonuploadrep
ErrorDocument     403 /adm/login
ErrorDocument     404 /adm/notfound.html
ErrorDocument     406 /adm/roles
ErrorDocument	  500 /adm/errorhandler
</LocationMatch>

<LocationMatch "^/+editupload.*">
AuthType LONCAPA
Require valid-user
PerlAuthzHandler	Apache::lonacc
ErrorDocument     403 /adm/login
ErrorDocument     406 /adm/roles
ErrorDocument	  500 /adm/errorhandler
</LocationMatch>

<LocationMatch "^/+uploaded/.*/.*/internal/.*">
PerlAuthenHandler	Apache::lonuploadedacc
PerlAuthzHandler	Apache::lonuploadedacc::skip_phase
PerlAccessHandler	Apache::lonuploadedacc::skip_phase
</LocationMatch>

<LocationMatch "^/+uploaded/.*/.*/portfolio/.*">
PerlAccessHandler      Apache::publiccheck
AuthType LONCAPA
Require valid-user
PerlAuthzHandler       Apache::lonacc
</LocationMatch>

<LocationMatch "^/+uploaded/.*/.*/groups/.*/portfolio/.*">
PerlAccessHandler      Apache::publiccheck
AuthType LONCAPA
Require valid-user
PerlAuthzHandler       Apache::lonacc
</LocationMatch>

<LocationMatch "^/+uploaded/.*\.page$">
SetHandler perl-script
PerlHandler Apache::lonpage
</LocationMatch>

<LocationMatch "^/+uploaded/.*\.sequence$">
SetHandler perl-script
PerlHandler Apache::lonsequence
</LocationMatch>

<LocationMatch "^/+public/.*/syllabus$">
PerlAccessHandler      Apache::publiccheck
AuthType LONCAPA
Require valid-user
PerlAuthzHandler	Apache::lonacc
SetHandler              perl-script
PerlHandler             Apache::lonsyllabus
ErrorDocument     404 /adm/notfound.html
ErrorDocument	  500 /adm/errorhandler
</LocationMatch>

<LocationMatch "^/+(public|adm)/.*(\.rss|_rss\.html)$">
PerlAccessHandler      Apache::publiccheck
AuthType LONCAPA
Require valid-user
PerlAuthzHandler	Apache::lonacc
SetHandler              perl-script
PerlHandler             Apache::lonrss
ErrorDocument     404 /adm/notfound.html
ErrorDocument	  500 /adm/errorhandler
</LocationMatch>

<LocationMatch "^/adm/.*/aboutme$">
AuthType LONCAPA
Require valid-user
PerlAuthzHandler	Apache::lonacc
SetHandler              perl-script
PerlHandler             Apache::lonaboutme
ErrorDocument     404 /adm/notfound.html
ErrorDocument     406 /adm/notinit.html
ErrorDocument	  500 /adm/errorhandler
</LocationMatch>

<LocationMatch "^/adm/.*/aboutme/portfolio$">
PerlAccessHandler       Apache::publiccheck
AuthType LONCAPA
Require valid-user
PerlAuthzHandler	Apache::lonacc
SetHandler              perl-script
PerlHandler             Apache::lonaboutme
ErrorDocument     404 /adm/notfound.html
ErrorDocument     406 /adm/notinit.html
ErrorDocument	  500 /adm/errorhandler
</LocationMatch>

<LocationMatch "^/adm/.*/smppg$">
AuthType LONCAPA
Require valid-user
PerlAuthzHandler	Apache::lonacc
SetHandler              perl-script
PerlHandler             Apache::londatecheck
PerlHandler		Apache::lonipcheck
PerlHandler             Apache::lonsimplepage
ErrorDocument     404 /adm/notfound.html
ErrorDocument     406 /adm/notinit.html
ErrorDocument	  500 /adm/errorhandler
</LocationMatch>

<LocationMatch "^/adm/.*/bulletinboard$">
AuthType LONCAPA
Require valid-user
PerlAuthzHandler	Apache::lonacc
SetHandler              perl-script
PerlHandler             Apache::londatecheck
PerlHandler		Apache::lonipcheck
PerlHandler             Apache::lonbulletin
ErrorDocument     404 /adm/notfound.html
ErrorDocument     406 /adm/notinit.html
ErrorDocument	  500 /adm/errorhandler
</LocationMatch>

<LocationMatch "\.problem/smpedit$">
AuthType LONCAPA
Require valid-user
PerlAuthzHandler	Apache::lonacc
SetHandler              perl-script
PerlHandler             Apache::lonsimpleproblemedit
ErrorDocument     404 /adm/notfound.html
ErrorDocument     406 /adm/notinit.html
ErrorDocument	  500 /adm/errorhandler
</LocationMatch>

<LocationMatch "^/+priv.*">
AuthType LONCAPA
Require valid-user
PerlAuthzHandler Apache::loncacc
SetHandler        perl-script
PerlHandler       Apache::lonconstruct
ErrorDocument     403 /adm/login
ErrorDocument     404 /adm/notfound.html
ErrorDocument     406 /adm/unauthorized
ErrorDocument	  500 /adm/errorhandler
</LocationMatch>

<LocationMatch "^/+raw.*">
PerlAccessHandler Apache::lonracc
</LocationMatch>

<LocationMatch "^/+\~.*">
AuthType LONCAPA
Require valid-user
PerlAuthzHandler Apache::loncacc
ErrorDocument     403 /adm/login
ErrorDocument     404 /adm/notfound.html
ErrorDocument     406 /adm/unauthorized
ErrorDocument	  500 /adm/errorhandler
</LocationMatch>

<LocationMatch "^/adm/helper/.*\.helper$">
AuthType LONCAPA
Require valid-user
PerlAuthzHandler  Apache::lonacc
SetHandler        perl-script
PerlHandler       Apache::lonhelper
ErrorDocument     403 /adm/login
ErrorDocument     404 /adm/notfound.html
ErrorDocument     406 /adm/unauthorized
ErrorDocument     500 /adm/errorhandler
</LocationMatch>

<LocationMatch "/prtspool">
AuthType LONCAPA
Require valid-user
PerlAuthzHandler Apache::lonacc
ErrorDocument     403 /adm/login
ErrorDocument     404 /adm/notfound.html
ErrorDocument     406 /adm/roles
ErrorDocument     413 /adm/overloaded.txt
ErrorDocument	  500 /adm/errorhandler
</LocationMatch>

<LocationMatch "/zipspool">
AuthType LONCAPA
Require valid-user
PerlAuthzHandler Apache::lonacc
ErrorDocument     403 /adm/login
ErrorDocument     404 /adm/notfound.html
ErrorDocument     406 /adm/roles
ErrorDocument     413 /adm/overloaded.txt
ErrorDocument	  500 /adm/errorhandler
</LocationMatch>
# ------------------------------------------------------------------------- RAT

<LocationMatch "^/\~.*\.sequence$">
SetHandler perl-script
PerlHandler Apache::lonratedt
</LocationMatch>

<LocationMatch "^/\~.*\.page$">
SetHandler perl-script
PerlHandler Apache::lonratedt
</LocationMatch>

<LocationMatch "^/\~.*\/ratserver$">
SetHandler perl-script
PerlHandler Apache::lonratsrv
</LocationMatch>

<LocationMatch "^/\~.*\/adveditmenu$">
SetHandler perl-script
PerlHandler Apache::lonratmenu
</LocationMatch>

<Location /adm/ratparms>
AuthType LONCAPA
Require valid-user
PerlAuthzHandler       Apache::lonacc
SetHandler perl-script
PerlHandler Apache::lonratparms
ErrorDocument     403 /adm/login
ErrorDocument	  500 /adm/errorhandler
</Location>

# --------------------------------------------- Resource Space Content Handlers

<LocationMatch "^/+res.*/$">
SetHandler perl-script
PerlHandler Apache::lonindexer
PerlCleanupHandler Apache::lonindexer::cleanup
PerlCleanupHandler	Apache::lonacc::cleanup
</LocationMatch>

<LocationMatch "^/+res.*\.tex$">
SetHandler perl-script
PerlHandler Apache::lontex
</LocationMatch>

<LocationMatch "^/+res/.*\.page$">
SetHandler perl-script
PerlHandler Apache::lonpage
</LocationMatch>

<LocationMatch "^/+res/.*\.sequence$">
SetHandler perl-script
PerlHandler Apache::lonsequence
</LocationMatch>

<LocationMatch "^/+(res|\~|public|uploaded|editupload|adm).*\.meta$">
PerlAccessHandler      Apache::publiccheck
SetHandler perl-script
PerlHandler Apache::lonmeta
ErrorDocument     413 /adm/overloaded.txt
</LocationMatch>

<LocationMatch "^/adm/bombs/">
AuthType LONCAPA
Require valid-user
SetHandler perl-script
PerlAuthzHandler Apache::lonacc
PerlHandler Apache::lonmeta
</LocationMatch>



<LocationMatch "^/+(res|\~).*\.rights$">
SetHandler perl-script
PerlHandler Apache::lonrights
</LocationMatch>

<LocationMatch "^/+(uploaded|res|\~).*\.(xml|html|htm|xhtml|xhtm|sty)$">
SetHandler perl-script
PerlHandler Apache::londatecheck
PerlHandler Apache::lonipcheck
PerlHandler Apache::lonxml
</LocationMatch>

<LocationMatch "^/+(res|\~).*\.(task|problem|exam|quiz|assess|survey|form|library)$">
SetHandler perl-script
PerlHandler Apache::lonhomework
</LocationMatch>

<LocationMatch "^/+\~.*\.(js|css|txt|tex)$">
SetHandler perl-script
PerlHandler Apache::lonxml
</LocationMatch>

<LocationMatch "^/adm/wrapper/">
AuthType LONCAPA
Require valid-user
PerlAuthzHandler       Apache::lonacc
PerlHandler Apache::londatecheck
PerlHandler Apache::lonipcheck
SetHandler perl-script
PerlHandler Apache::lonwrapper
ErrorDocument     403 /adm/login
ErrorDocument	  500 /adm/errorhandler
</LocationMatch>

<LocationMatch "^/adm/source">
AuthType LONCAPA
Require valid-user
PerlAuthzHandler       Apache::lonacc
SetHandler perl-script
PerlHandler Apache::lonsource
ErrorDocument     403 /adm/login
ErrorDocument     406 /adm/roles
ErrorDocument	  500 /adm/errorhandler
</LocationMatch>


<LocationMatch "^/adm/localize/">
AuthType LONCAPA
Require valid-user
PerlAuthzHandler       Apache::lonacc
SetHandler perl-script
PerlHandler Apache::lonlocalize
ErrorDocument     403 /adm/login
ErrorDocument	  500 /adm/errorhandler
</LocationMatch>

# -------------------------------------------------------------- Admin Programs

<Location /adm/randomlabel.png>
AuthType LONCAPA
Require valid-user
PerlAuthzHandler       Apache::lonacc
SetHandler perl-script
PerlHandler Apache::randomlylabel
ErrorDocument     403 /adm/login
ErrorDocument	  500 /adm/errorhandler
</Location>

<Location /adm/imagechoice>
AuthType LONCAPA
Require valid-user
PerlAuthzHandler       Apache::lonacc
SetHandler perl-script
PerlHandler Apache::imagechoice
ErrorDocument     403 /adm/login
ErrorDocument	  500 /adm/errorhandler
</Location>

<Location /adm/statistics>
AuthType LONCAPA
Require valid-user
PerlAuthzHandler       Apache::lonacc
SetHandler perl-script
PerlHandler Apache::lonstatistics
ErrorDocument     403 /adm/login
ErrorDocument     413 /adm/overloaded.txt
ErrorDocument	  500 /adm/errorhandler
</Location>

<Location /adm/trackstudent>
AuthType LONCAPA
Require valid-user
PerlAuthzHandler       Apache::lonacc
SetHandler perl-script
PerlHandler Apache::lontrackstudent
ErrorDocument     403 /adm/login
ErrorDocument     413 /adm/overloaded.txt
ErrorDocument	  500 /adm/errorhandler
</Location>

<Location /adm/roles>
AuthType LONCAPA
Require valid-user
PerlAuthzHandler       Apache::lonacc
SetHandler perl-script
PerlHandler Apache::lonroles
ErrorDocument     403 /adm/login
ErrorDocument     409 /adm/preferences?action=lockwarning
ErrorDocument	  500 /adm/errorhandler
</Location>

<Location /adm/menu>
AuthType LONCAPA
Require valid-user
PerlAuthzHandler       Apache::lonacc
SetHandler perl-script
PerlHandler Apache::lonmainmenu
ErrorDocument     403 /adm/login
ErrorDocument	  500 /adm/errorhandler
</Location>

<Location /adm/pickauthor>
AuthType LONCAPA
Require valid-user
PerlAuthzHandler       Apache::lonacc
SetHandler perl-script
PerlHandler Apache::lonpickauthor
ErrorDocument     403 /adm/login
ErrorDocument     500 /adm/errorhandler
</Location>

<Location /adm/pickstudent>
AuthType LONCAPA
Require valid-user
PerlAuthzHandler       Apache::lonacc
SetHandler perl-script
PerlHandler Apache::lonpickstudent
ErrorDocument     403 /adm/login
ErrorDocument	  500 /adm/errorhandler
</Location>

<Location /adm/pickuser>
AuthType LONCAPA
Require valid-user
PerlAuthzHandler       Apache::lonacc
SetHandler perl-script
PerlHandler Apache::lonpickuser
ErrorDocument     403 /adm/login
ErrorDocument     406 /adm/roles
ErrorDocument     500 /adm/errorhandler
</Location>

<Location /adm/pickcourse>
AuthType LONCAPA
Require valid-user
PerlAuthzHandler       Apache::lonacc
SetHandler perl-script
PerlHandler Apache::lonpickcourse
ErrorDocument     403 /adm/login
ErrorDocument	  500 /adm/errorhandler
</Location>

<Location /adm/pickcode>
AuthType LONCAPA
Require valid-user
PerlAuthzHandler       Apache::lonacc
SetHandler perl-script
PerlHandler Apache::lonpickcode
ErrorDocument     403 /adm/login
ErrorDocument	  500 /adm/errorhandler
</Location>

<Location /adm/login>
SetHandler perl-script
PerlHandler Apache::lonlogin
</Location>

<Location /adm/restrictedaccess>
PerlAccessHandler      Apache::publiccheck
AuthType LONCAPA
Require valid-user
SetHandler perl-script
PerlAuthzHandler       Apache::lonacc
PerlHandler Apache::restrictedaccess
ErrorDocument	  500 /adm/errorhandler
</Location>

<Location /adm/blockedaccess>
PerlAccessHandler      Apache::publiccheck
AuthType LONCAPA
Require valid-user
SetHandler perl-script
PerlAuthzHandler       Apache::lonacc
PerlHandler Apache::blockedaccess
ErrorDocument     500 /adm/errorhandler
</Location>

<Location /adm/logout>
AuthType LONCAPA
Require valid-user
PerlAuthzHandler       Apache::lonacc
SetHandler perl-script
PerlHandler Apache::lonlogout
ErrorDocument     403 /adm/login
ErrorDocument     409 /adm/preferences?action=lockwarning
ErrorDocument	  500 /adm/errorhandler
</Location>

<Location /adm/switchserver>
AuthType LONCAPA
Require valid-user
PerlAuthzHandler       Apache::lonacc
SetHandler perl-script
PerlHandler Apache::switchserver
ErrorDocument     403 /adm/login
ErrorDocument	  500 /adm/errorhandler
</Location>

<Location /adm/authenticate>
SetHandler perl-script
PerlHandler Apache::lonauth
</Location>

<Location /adm/migrateuser>
SetHandler perl-script
PerlHandler Apache::migrateuser
</Location>

<Location /adm/annotations>
AuthType LONCAPA
Require valid-user
PerlAuthzHandler       Apache::lonacc
SetHandler perl-script
PerlHandler Apache::admannotations
ErrorDocument     403 /adm/login
ErrorDocument	  500 /adm/errorhandler
</Location>

<Location /adm/spellcheck>
AuthType LONCAPA
Require valid-user
PerlAuthzHandler       Apache::lonacc
SetHandler perl-script
PerlHandler Apache::lonspeller
ErrorDocument     403 /adm/login
ErrorDocument	  500 /adm/errorhandler
</Location>

<Location /adm/flip>
AuthType LONCAPA
Require valid-user
PerlAuthzHandler       Apache::lonacc
SetHandler perl-script
PerlHandler Apache::lonpageflip
PerlCleanupHandler Apache::lonpageflip::cleanup
PerlCleanupHandler	Apache::lonacc::cleanup
ErrorDocument     406 /adm/roles
ErrorDocument     403 /adm/login
ErrorDocument	  500 /adm/errorhandler
</Location>

<Location /adm/ambiguous>
AuthType LONCAPA
Require valid-user
PerlAuthzHandler       Apache::lonacc
SetHandler perl-script
PerlHandler Apache::lonambiguous
PerlCleanupHandler Apache::lonambiguous::cleanup
PerlCleanupHandler	Apache::lonacc::cleanup
ErrorDocument     403 /adm/login
ErrorDocument	  500 /adm/errorhandler
</Location>

<Location /adm/email>
AuthType LONCAPA
Require valid-user
PerlAuthzHandler       Apache::lonacc
SetHandler perl-script
PerlHandler Apache::lonmsgdisplay
ErrorDocument     403 /adm/login
ErrorDocument	  500 /adm/errorhandler
</Location>

<Location /adm/notify>
AuthType LONCAPA
Require valid-user
PerlAuthzHandler       Apache::lonacc
SetHandler perl-script
PerlHandler Apache::lonnotify
ErrorDocument     403 /adm/login
ErrorDocument     500 /adm/errorhandler
</Location>

<Location /adm/parmset>
AuthType LONCAPA
Require valid-user
PerlAuthzHandler       Apache::lonacc
SetHandler perl-script
PerlHandler Apache::lonparmset
ErrorDocument     403 /adm/login
ErrorDocument     406 /adm/roles
ErrorDocument	  500 /adm/errorhandler
</Location>

<Location /adm/courseprefs>
AuthType LONCAPA
Require valid-user
PerlAuthzHandler       Apache::lonacc
SetHandler perl-script
PerlHandler Apache::courseprefs
ErrorDocument     403 /adm/login
ErrorDocument     406 /adm/roles
ErrorDocument     500 /adm/errorhandler
</Location>

<Location /adm/slotrequest>
AuthType LONCAPA
Require valid-user
PerlAuthzHandler       Apache::lonacc
SetHandler perl-script
PerlHandler Apache::slotrequest
ErrorDocument     403 /adm/login
ErrorDocument     406 /adm/roles
ErrorDocument	  500 /adm/errorhandler
</Location>

<Location /adm/wizard>
AuthType LONCAPA
Require valid-user
PerlAuthzHandler       Apache::lonacc
SetHandler perl-script
PerlHandler Apache::lonwizard
ErrorDocument     403 /adm/login
ErrorDocument     406 /adm/roles
ErrorDocument	  500 /adm/errorhandler
</Location>

<Location /adm/grades>
AuthType LONCAPA
Require valid-user
PerlAuthzHandler       Apache::lonacc
SetHandler perl-script
PerlHandler Apache::grades
ErrorDocument     403 /adm/login
ErrorDocument     406 /adm/roles
ErrorDocument	  500 /adm/errorhandler
</Location>

<Location /adm/requestcourse>
AuthType LONCAPA
Require valid-user
PerlAuthzHandler       Apache::lonacc
SetHandler perl-script
PerlHandler Apache::lonrequestcourse
ErrorDocument     403 /adm/login
ErrorDocument     406 /adm/roles
ErrorDocument     500 /adm/errorhandler
</Location>

<Location /adm/createcourse>
AuthType LONCAPA
Require valid-user
PerlAuthzHandler       Apache::lonacc
SetHandler perl-script
PerlHandler Apache::loncreatecourse
ErrorDocument     403 /adm/login
ErrorDocument     406 /adm/roles
ErrorDocument	  500 /adm/errorhandler
</Location>

<Location /adm/modifycourse>
AuthType LONCAPA
Require valid-user
PerlAuthzHandler       Apache::lonacc
SetHandler perl-script
PerlHandler Apache::lonmodifycourse
ErrorDocument     403 /adm/login
ErrorDocument     406 /adm/roles
ErrorDocument     500 /adm/errorhandler
</Location>

<Location /adm/domainprefs>
AuthType LONCAPA
Require valid-user
PerlAuthzHandler       Apache::lonacc
SetHandler perl-script
PerlHandler Apache::domainprefs
ErrorDocument     403 /adm/login
ErrorDocument     406 /adm/roles
ErrorDocument     500 /adm/errorhandler
</Location>

<Location /adm/domainstatus>
PerlAccessHandler       Apache::lonstatusacc
SetHandler perl-script
PerlHandler Apache::domainstatus
ErrorDocument     403 /adm/login
ErrorDocument     406 /adm/roles
ErrorDocument     500 /adm/errorhandler
</Location>

<Location /adm/createuser>
AuthType LONCAPA
Require valid-user
PerlAuthzHandler       Apache::lonacc
SetHandler perl-script
PerlHandler Apache::loncreateuser
ErrorDocument     403 /adm/login
ErrorDocument     406 /adm/roles
ErrorDocument	  500 /adm/errorhandler
</Location>

<Location /adm/publish>
AuthType LONCAPA
Require valid-user
PerlAuthzHandler       Apache::lonacc
SetHandler perl-script
PerlHandler Apache::lonpublisher
ErrorDocument     403 /adm/login
ErrorDocument     404 /adm/notfound.html
ErrorDocument     406 /adm/unauthorized
ErrorDocument	  500 /adm/errorhandler
</Location>

<LocationMatch "^/+\~.*/$">
AuthType LONCAPA
Require valid-user
PerlAuthzHandler       Apache::loncacc
SetHandler perl-script
PerlHandler Apache::lonpubdir
ErrorDocument     403 /adm/login
ErrorDocument     404 /adm/notfound.html
ErrorDocument     406 /adm/unauthorized
ErrorDocument	  500 /adm/errorhandler
</LocationMatch>

<Location /adm/pubdir>
AuthType LONCAPA
Require valid-user
PerlAuthzHandler       Apache::lonacc
SetHandler perl-script
PerlHandler Apache::lonpubdir
ErrorDocument     403 /adm/login
ErrorDocument     404 /adm/notfound.html
ErrorDocument     406 /adm/unauthorized
ErrorDocument	  500 /adm/errorhandler
</Location>

<Location /adm/unauthorized>
AuthType LONCAPA
Require valid-user
PerlAuthzHandler       Apache::lonacc
SetHandler perl-script
PerlHandler Apache::lonunauthorized
ErrorDocument     403 /adm/login
ErrorDocument     404 /adm/notfound.html
ErrorDocument	  500 /adm/errorhandler
</Location>

<Location /adm/retrieve>
AuthType LONCAPA
Require valid-user
PerlAuthzHandler       Apache::lonacc
SetHandler perl-script
PerlHandler Apache::lonretrieve
ErrorDocument     403 /adm/login
ErrorDocument     404 /adm/notfound.html
ErrorDocument     406 /adm/unauthorized
ErrorDocument	  500 /adm/errorhandler
</Location>

<Location /adm/cleanup>
AuthType LONCAPA
Require valid-user
PerlAuthzHandler       Apache::lonacc
SetHandler perl-script
PerlHandler Apache::loncleanup
ErrorDocument     403 /adm/login
ErrorDocument     404 /adm/notfound.html
ErrorDocument     406 /adm/unauthorized
ErrorDocument	  500 /adm/errorhandler
</Location>

<Location /adm/cfile>
AuthType LONCAPA
Require valid-user
PerlAuthzHandler       Apache::lonacc
SetHandler perl-script
PerlHandler Apache::loncfile
ErrorDocument     403 /adm/login
ErrorDocument     404 /adm/notfound.html
ErrorDocument     406 /adm/unauthorized
ErrorDocument	  500 /adm/errorhandler
</Location>

<Location /adm/diff>
AuthType LONCAPA
Require valid-user
PerlAuthzHandler       Apache::lonacc
SetHandler perl-script
PerlHandler Apache::londiff
ErrorDocument     403 /adm/login
ErrorDocument     404 /adm/notfound.html
ErrorDocument     406 /adm/unauthorized
ErrorDocument	  500 /adm/errorhandler
</Location>

<Location /adm/upload>
AuthType LONCAPA
Require valid-user
PerlAuthzHandler       Apache::lonacc
SetHandler perl-script
PerlHandler Apache::lonupload
ErrorDocument     403 /adm/login
ErrorDocument     404 /adm/notfound.html
ErrorDocument     406 /adm/unauthorized
ErrorDocument	  500 /adm/errorhandler
</Location>

<Location /adm/imsimport>
AuthType LONCAPA
Require valid-user
PerlAuthzHandler       Apache::lonacc
SetHandler perl-script
PerlHandler Apache::imsimport
ErrorDocument     403 /adm/login
ErrorDocument     404 /adm/notfound.html
ErrorDocument     406 /adm/unauthorized
ErrorDocument     500 /adm/errorhandler
</Location>

<Location /adm/testbank>
AuthType LONCAPA
Require valid-user
PerlAuthzHandler       Apache::lonacc
SetHandler perl-script
PerlHandler Apache::testbankimport
ErrorDocument     403 /adm/login
ErrorDocument     404 /adm/notfound.html
ErrorDocument     406 /adm/unauthorized
ErrorDocument     500 /adm/errorhandler
</Location>

<Location /adm/assesscalc>
AuthType LONCAPA
Require valid-user
PerlAuthzHandler       Apache::lonacc
SetHandler perl-script
PerlHandler Apache::lonspreadsheet
ErrorDocument     403 /adm/login
ErrorDocument     406 /adm/roles
ErrorDocument     413 /adm/overloaded.txt
ErrorDocument	  500 /adm/errorhandler
</Location>

<Location /adm/studentcalc>
AuthType LONCAPA
Require valid-user
PerlAuthzHandler       Apache::lonacc
SetHandler perl-script
PerlHandler Apache::lonspreadsheet
ErrorDocument     403 /adm/login
ErrorDocument     406 /adm/roles
ErrorDocument     413 /adm/overloaded.txt
ErrorDocument	  500 /adm/errorhandler
</Location>

<Location /adm/classcalc>
AuthType LONCAPA
Require valid-user
PerlAuthzHandler       Apache::lonacc
SetHandler perl-script
PerlHandler Apache::lonspreadsheet
ErrorDocument     403 /adm/login
ErrorDocument     406 /adm/roles
ErrorDocument     413 /adm/overloaded.txt
ErrorDocument	  500 /adm/errorhandler
</Location>

<Location /adm/dropadd>
AuthType LONCAPA
Require valid-user
PerlAuthzHandler       Apache::lonacc
SetHandler perl-script
PerlHandler Apache::londropadd
ErrorDocument     403 /adm/login
ErrorDocument     406 /adm/roles
ErrorDocument	  500 /adm/errorhandler
</Location>

<Location /adm/viewclasslist>
AuthType LONCAPA
Require valid-user
PerlAuthzHandler       Apache::lonacc
SetHandler perl-script
PerlHandler Apache::lonviewclasslist
ErrorDocument     403 /adm/login
ErrorDocument     406 /adm/roles
ErrorDocument	  500 /adm/errorhandler
</Location>

<Location /adm/coursegroups>
AuthType LONCAPA
Require valid-user
PerlAuthzHandler       Apache::lonacc
SetHandler perl-script
PerlHandler Apache::loncoursegroups
ErrorDocument     403 /adm/login
ErrorDocument     406 /adm/roles
ErrorDocument     500 /adm/errorhandler
</Location>

<Location /adm/groupboards>
AuthType LONCAPA
Require valid-user
PerlAuthzHandler       Apache::lonacc
SetHandler perl-script
PerlHandler Apache::groupboards
ErrorDocument     403 /adm/login
ErrorDocument     406 /adm/roles
ErrorDocument     500 /adm/errorhandler
</Location>

<Location /adm/grouproster>
AuthType LONCAPA
Require valid-user
PerlAuthzHandler       Apache::lonacc
SetHandler perl-script
PerlHandler Apache::grouproster
ErrorDocument     403 /adm/login
ErrorDocument     406 /adm/roles
ErrorDocument     500 /adm/errorhandler
</Location>

<Location /adm/whatsnew>
AuthType LONCAPA
Require valid-user
PerlAuthzHandler       Apache::lonacc
SetHandler perl-script
PerlHandler Apache::lonwhatsnew
ErrorDocument     403 /adm/login
ErrorDocument     406 /adm/roles
ErrorDocument     500 /adm/errorhandler
</Location>

<Location /adm/populate>
AuthType LONCAPA
Require valid-user
PerlAuthzHandler       Apache::lonacc
SetHandler perl-script
PerlHandler Apache::lonpopulate
ErrorDocument     403 /adm/login
ErrorDocument     406 /adm/roles
ErrorDocument     500 /adm/errorhandler
</Location>

<Location /adm/managekeys>
AuthType LONCAPA
Require valid-user
PerlAuthzHandler       Apache::lonacc
SetHandler perl-script
PerlHandler Apache::lonmanagekeys
ErrorDocument     403 /adm/login
ErrorDocument     406 /adm/roles
ErrorDocument	  500 /adm/errorhandler
</Location>

<Location /adm/printout>
AuthType LONCAPA
Require valid-user
PerlAuthzHandler       Apache::lonacc
SetHandler perl-script
PerlHandler Apache::lonprintout
ErrorDocument     403 /adm/login
ErrorDocument     413 /adm/overloaded.txt
ErrorDocument	  500 /adm/errorhandler
</Location>

<Location /adm/feedback>
AuthType LONCAPA
Require valid-user
PerlAuthzHandler       Apache::lonacc
SetHandler perl-script
PerlHandler Apache::lonfeedback
ErrorDocument     403 /adm/login
ErrorDocument	  500 /adm/errorhandler
</Location>

<Location /adm/coursedocs>
AuthType LONCAPA
Require valid-user
PerlAuthzHandler       Apache::lonacc
SetHandler perl-script
PerlHandler Apache::londocs
PerlCleanupHandler Apache::londocs::untiehash
PerlCleanupHandler	Apache::lonacc::cleanup
ErrorDocument     403 /adm/login
ErrorDocument	  500 /adm/errorhandler
</Location>

<Location /adm/imsimportdocs>
AuthType LONCAPA
Require valid-user
PerlAuthzHandler       Apache::lonacc
SetHandler perl-script
PerlHandler Apache::imsimportdocs
ErrorDocument     403 /adm/login
ErrorDocument     500 /adm/errorhandler
</Location>

<LocationMatch "^/adm/announcements">
AuthType LONCAPA
Require valid-user
PerlAuthzHandler       Apache::lonacc
SetHandler perl-script
PerlHandler Apache::lonannounce
ErrorDocument     403 /adm/login
ErrorDocument	  500 /adm/errorhandler
</LocationMatch>

<Location /adm/chat>
AuthType LONCAPA
Require valid-user
PerlAuthzHandler       Apache::lonacc
SetHandler perl-script
PerlHandler Apache::lonchat
ErrorDocument	  500 /adm/errorhandler
</Location>

<Location /adm/chatfetch>
AuthType LONCAPA
Require valid-user
PerlAuthzHandler       Apache::lonacc
SetHandler perl-script
PerlHandler Apache::lonchatfetch
ErrorDocument     413 /adm/overloaded.txt
ErrorDocument	  500 /adm/errorhandler
</Location>

<Location /adm/groupchat>
AuthType LONCAPA
Require valid-user
PerlAuthzHandler       Apache::lonacc
SetHandler perl-script
PerlHandler Apache::longroupchat
ErrorDocument     403 /adm/login
ErrorDocument     500 /adm/errorhandler
</Location>

<Location /adm/evaluate>
AuthType LONCAPA
Require valid-user
PerlAuthzHandler       Apache::lonacc
SetHandler perl-script
PerlHandler Apache::lonevaluate
ErrorDocument     403 /adm/login
ErrorDocument	  500 /adm/errorhandler
</Location>

<Location /adm/preferences>
AuthType LONCAPA
Require valid-user
PerlAuthzHandler       Apache::lonacc
SetHandler perl-script
PerlHandler Apache::lonpreferences
ErrorDocument     403 /adm/login
ErrorDocument	  500 /adm/errorhandler
</Location>

<Location /adm/communicate>
AuthType LONCAPA
Require valid-user
PerlAuthzHandler       Apache::lonacc
SetHandler perl-script
PerlHandler Apache::loncommunicate
ErrorDocument     403 /adm/login
ErrorDocument	  500 /adm/errorhandler
</Location>

<Location /adm/searchcat>
AuthType LONCAPA
Require valid-user
PerlAuthzHandler       Apache::lonacc
SetHandler perl-script
PerlHandler Apache::lonsearchcat
PerlCleanupHandler Apache::lonsearchcat::cleanup
PerlCleanupHandler	Apache::lonacc::cleanup
ErrorDocument     403 /adm/login
ErrorDocument     413 /adm/overloaded.txt
ErrorDocument	  500 /adm/errorhandler
</Location>

<Location /adm/navmaps>
AuthType LONCAPA
Require valid-user
PerlAuthzHandler       Apache::lonacc
SetHandler perl-script
PerlHandler Apache::lonnavdisplay
ErrorDocument     403 /adm/login
ErrorDocument     406 /adm/roles
ErrorDocument	  500 /adm/errorhandler
</Location>

<Location /adm/quickgrades>
AuthType LONCAPA
Require valid-user
PerlAuthzHandler       Apache::lonacc
SetHandler perl-script
PerlHandler Apache::lonquickgrades
ErrorDocument     403 /adm/login
ErrorDocument     406 /adm/roles
ErrorDocument     500 /adm/errorhandler
</Location>

<Location /adm/groupsort>
AuthType LONCAPA
Require valid-user
PerlAuthzHandler	Apache::lonacc
SetHandler perl-script
PerlHandler Apache::groupsort
PerlCleanupHandler Apache::groupsort::cleanup
PerlCleanupHandler	Apache::lonacc::cleanup
ErrorDocument     403 /adm/login
ErrorDocument	  500 /adm/errorhandler
</Location>

<Location /adm/wishlist>
AuthType LONCAPA
Require valid-user
PerlAuthzHandler       Apache::lonacc
SetHandler perl-script
PerlHandler Apache::lonwishlist
ErrorDocument     403 /adm/login
ErrorDocument     406 /adm/roles
ErrorDocument	  500 /adm/errorhandler
</Location>

<Location /adm/blockingstatus>
PerlAccessHandler      Apache::publiccheck
AuthType LONCAPA
Require valid-user
PerlAuthzHandler       Apache::lonacc
SetHandler             perl-script
PerlHandler            Apache::lonblockingstatus
</Location>

<Location /adm/errorhandler>
SetHandler perl-script
PerlHandler Apache::lonerrorhandler
</Location>

<LocationMatch "^/adm/help/.*\.hlp$">
AuthType LONCAPA
Require valid-user
PerlAccessHandler      Apache::publiccheck
PerlAuthzHandler	Apache::lonacc
SetHandler perl-script
PerlHandler Apache::lonhelp
ErrorDocument	  500 /adm/errorhandler
</LocationMatch>

<LocationMatch "^/adm/helpmenu">
AuthType LONCAPA
Require valid-user
PerlAuthzHandler       Apache::lonacc
SetHandler perl-script
PerlHandler Apache::lonhelpmenu
ErrorDocument	  500 /adm/errorhandler
</LocationMatch>

<LocationMatch "^/adm/support">
AuthType LONCAPA
Require valid-user
PerlAuthzHandler       Apache::lonacc
SetHandler perl-script
PerlHandler Apache::lonsupportreq
ErrorDocument	  500 /adm/errorhandler
</LocationMatch>

<LocationMatch "^/adm/helpdesk">
SetHandler perl-script
PerlHandler Apache::lonsupportreq
ErrorDocument	  500 /adm/errorhandler
</LocationMatch>

<LocationMatch "^/adm/css">
SetHandler perl-script
PerlHandler Apache::loncss
ErrorDocument	  500 /adm/errorhandler
</LocationMatch>

<LocationMatch "^/adm/coursecatalog">
SetHandler perl-script
PerlHandler Apache::coursecatalog
ErrorDocument	  500 /adm/errorhandler
</LocationMatch>

<LocationMatch "^/adm/resetpw">
SetHandler perl-script
PerlHandler Apache::resetpw
ErrorDocument     500 /adm/errorhandler
</LocationMatch>

<LocationMatch "^/adm/selfenroll">
SetHandler perl-script
PerlHandler Apache::selfenroll
ErrorDocument     500 /adm/errorhandler
</LocationMatch>

<LocationMatch "^/adm/createaccount">
SetHandler perl-script
PerlHandler Apache::createaccount
ErrorDocument     500 /adm/errorhandler
</LocationMatch>

<LocationMatch "^/adm/dns">
SetHandler perl-script
PerlHandler Apache::londns
ErrorDocument     500 /adm/errorhandler
</LocationMatch>

# ------------------------------------------------- Backdoor Adm Tests/Programs

<Location /adm/test>
PerlAccessHandler Apache::lonstatusacc
SetHandler perl-script
PerlHandler Apache::lontest
</Location>

# ------------------------------------------------------- Shutting down a child

PerlChildExitHandler Apache::lonacc::goodbye

#
# LON-CAPA Section (extensions to access.conf permission configuration)
#
# =========================================================== Directory Options

# Start out with "no"

<Directory />
Options None
AllowOverride None
order deny,allow
deny from all
</Directory>

# Allow uploaded files to be served

<Directory "/home/httpd/lonUsers">
Options Includes FollowSymLinks
AllowOverride None
order allow,deny
allow from all
</Directory>
 
# Allow construction space files to be served

<Directory "/home/*/public_html/" >
Options Includes FollowSymLinks
AllowOverride
order allow,deny
allow from all
</Directory>

# Yes to symbolic links and server-side includes

<Directory /home/httpd/html>
Options Includes FollowSymLinks
AllowOverride None
order allow,deny
allow from all
</Directory>

# If it is in cgi-bin, then it can be executed as a CGI script.

<Directory /home/httpd/cgi-bin>
AllowOverride None
Options ExecCGI FollowSymLinks
order allow,deny
allow from all
</Directory>

# Allow serving of files in prtspool

<Directory "/home/httpd/prtspool/">
Options Includes FollowSymLinks
AllowOverride None
order allow,deny
allow from all
</Directory>

# Allow serving of files in zipspool

<Directory "/home/httpd/zipspool/">
Options Includes FollowSymLinks
AllowOverride None
order allow,deny
allow from all
</Directory>

# Allow serving of files in captchaspool

<Directory "/home/httpd/captchaspool/">
Options Includes FollowSymLinks
AllowOverride None
order allow,deny
allow from all
</Directory>

# ============================================================= Access Handlers

# ------------------------------------------------- Allow server-status reports
<Location /server-status>
PerlAccessHandler Apache::lonstatusacc
SetHandler server-status
</Location>

# ------------------------ Allow LON-CAPA "low-level" connection status reports
<LocationMatch "^/+lon-status/.*">
PerlAccessHandler Apache::lonstatusacc
ErrorDocument     406 /adm/roles
ErrorDocument     500 /adm/errorhandler
</LocationMatch>

# ------------------- Allow access to local system documentation from localhost
Alias /doc /usr/doc
<Directory /usr/doc>
order deny,allow
deny from all
allow from localhost
Options Indexes FollowSymLinks
</Directory>

# ******** THESE "SHOULD" NEVER BE ALTERED BY THE USER ************************
# ====================================== Internal Settings / Perl Configuration

PerlSetVar	 lonVersion   '<!-- VERSION -->'
PerlSetVar       lonIDsDir    /home/httpd/lonIDs
PerlSetVar       lonTabDir    /home/httpd/lonTabs
PerlSetVar       lonUsersDir  /home/httpd/lonUsers
PerlSetVar       lonIconsURL  /adm/lonIcons
PerlSetVar       londPort     5663
PerlSetVar       lonSysEMail  korte@lite.msu.edu
PerlSetVar       lonDaemons   /home/httpd/perl
PerlSetVar       lonLib       /home/httpd/lib
PerlSetVar       lonSockDir   /home/httpd/sockets
PerlSetVar       lonSockCreate   /home/httpd/sockets/common
PerlSetVar       lonDocRoot   /home/httpd/html
PerlSetVar       lonPrtDir    /home/httpd/prtspool
PerlSetVar       lonIncludes  /home/httpd/html/res/adm/includes
PerlSetVar       lonZipDir    /home/httpd/zipspool
PerlSetVar       lonCaptchaDir     /home/httpd/captchaspool
PerlSetVar       lonCaptchaDb     /home/httpd/captchadb 
PerlSetVar       lonFontsDir     /home/httpd/html/adm/fonts
# & separated list of : separated fields in order of
# - internal name to call it, 
# - regexp that it should match (done case-insensitively)
# - regexp that is should not match (done case-insensitively)
# - regexp that will pull out the version number into $1
# - a number that describes the minimum version that has mathml support
# - a number that describes the minimum number version that has unicode support

PerlSetVar       lonBrowsDet  explorer:msie:netscape:msie\s(\d+\.\d+)\;:9999:5&mozilla:mozilla\/[5-9]:msie:mozilla\/(\d+\.\d+)\s:9999:1&netscape:netscape:msie:netscape\/(\d+\.\d+):9999:7&netscape:netscape\/[7-9]:shouldnotmatch:netscape\/(\d+\.\d+):9999:7&amaya:amaya:mozilla:V(\d+\.\d+)\s:1:1&safari:safari:msie:safari\/([\d\.]+):9999:84

PerlSetVar       lonTextBrowsers windows\s+ce:lynx
PerlSetVar       lonScansDir  /home/httpd/scantron
PerlSetVar       lonScriptTimeout 10
PerlSetVar	 BugzillaHost	http://bugs.lon-capa.org/
PerlSetVar	 FAQHost	http://help.lon-capa.org/
# -----------------------------------------------------------------------------
# NOTE: lonSqlAccess key is the password for the MySQL user
# www@localhost.  This value must always be "localhostkey".
# The only security risk occurs when somebody logs in as 'www' on your system
# (in which case you have much bigger problems than whether or not they
# can access the non-authoritative loncapa database on your machine).

PerlSetVar       lonSqlAccess   localhostkey

#----------------------------------------------------------------------------
#
#   Parameters used by secure lond/lonc

#
#   Secure lond/lonc require ssl certificate and private
#   key files to function correctly.  The certificate
#   files need not be terribly secure, but the private key files
#   should be set up so that only www (the lonc/lond effective user)
#   can read them.
# 
#   The definition below is the full path to the directory that
#   contains the certificate and key files:

PerlSetVar lonCertificateDirectory /home/httpd/lonCerts

#
#  Secure lond/lonc require two certificates and a private host key.
#  The certificates required are that of the lonCAPA certificate authority
#  and the certificate that authority issued to this host.
#  lonnetCertificateAuthority is the name of the file that contains the
#                            lonCAPA certificate authority's certificate.
#  lonnetCertificate is the name of the file that contains the certificate
#                    issued to the host by the certificate authority.
#  Both of these variables are names of files assumed to be in 
#  lonCertificateDirectory:

PerlSetVar lonnetCertificateAuthority loncapaCA.pem
PerlSetVar lonnetCertificate          lonhostcert.pem

#
#  To generate the request for a certificate, and to negotiate the
#  initial ssl connection, the host requires a private key.  This key
#  is created at lonCAPA install time.  Did we mention above that it
#  should be set so that only www can read it?  The variale below
#  is the name of the file relative to lonnetCertificateDirectory
#  that has the host's private key.  Did we remember to tell you to
#  keep the permissions on that file set to rw-------  (0600)?
#  

PerlSetVar lonnetPrivateKey         lonKey.pem

# Did we mention that the file described above must have
# permissions really locked down so that it can't be stolen?

#-------------------------------------------------------------------------

#   Parameters that define where all the ssl stuff is that's needed
#   to generate certificate requests and, on a system that's a CA
#   the certificate authority.
#    
#    SSLProgram    -> Path to the openssl command
#    SSLDirectory  -> Directory containing ssl configuration files etc.
#    SSLCAConfig   -> Name of the SSL config file for the certificate 
#                     Authority.
#    SSLCAFile     -> Full path to the Certificate authority file 
#                    (on the cert manager system).
#    SSLEmail      -> E-mail address of loncapa certificate manager.
#    The following are good for the loncapa redhat installs and
#    the loncapa certificate authority system:
#
PerlSetVar SSLProgram	/usr/bin/openssl
PerlSetVar SSLDirectory /usr/share/ssl
PerlSetVar SSLCAConfig  loncapaca
PerlSetVar SSLCAFile    /usr/share/ssl/loncapaca/cacert.pem
PerlSetVar SSLEmail     certificate@lon-capa.org

#-------------------------------------------------------------------------




# ====================================== Include machine-specific configuration

Include conf/loncapa.conf

# ================================================= Include local configuration

Include conf/loncapa_apache_local*.conf

# ================================================== Initiate mod_perl starting

PerlRequire      conf/startup.pl
<IfDefine !MODPERL2>
PerlFreshRestart On
</IfDefine>

Index: modules/ehlerst/homescreen/loncommon.pm
+++ modules/ehlerst/homescreen/loncommon.pm
# The LearningOnline Network with CAPA
# a pile of common routines
#
# $Id: loncommon.pm,v 1.1 2011/03/19 15:47:12 ehlerst Exp $
#
# Copyright Michigan State University Board of Trustees
#
# This file is part of the LearningOnline Network with CAPA (LON-CAPA).
#
# LON-CAPA is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# LON-CAPA is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with LON-CAPA; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
#
# /home/httpd/html/adm/gpl.txt
#
# http://www.lon-capa.org/
#

# Makes a table out of the previous attempts
# Inputs result_from_symbread, user, domain, course_id
# Reads in non-network-related .tab files

# POD header:

=pod

=head1 NAME

Apache::loncommon - pile of common routines

=head1 SYNOPSIS

Common routines for manipulating connections, student answers,
    domains, common Javascript fragments, etc.

=head1 OVERVIEW

A collection of commonly used subroutines that don't have a natural
home anywhere else. This collection helps remove
redundancy from other modules and increase efficiency of memory usage.

=cut 

# End of POD header
package Apache::loncommon;

use strict;
use Apache::lonnet;
use GDBM_File;
use POSIX qw(strftime mktime);
use Apache::lonmenu();
use Apache::lonenc();
use Apache::lonlocal;
use Apache::lonnet();
use HTML::Entities;
use Apache::lonhtmlcommon();
use Apache::loncoursedata();
use Apache::lontexconvert();
use Apache::lonclonecourse();
use LONCAPA qw(:DEFAULT :match);
use DateTime::TimeZone;
use DateTime::Locale::Catalog;

# ---------------------------------------------- Designs
use vars qw(%defaultdesign);

my $readit;


##
## Global Variables
##


# ----------------------------------------------- SSI with retries:
#

=pod

=head1 Server Side include with retries:

=over 4

=item * &ssi_with_retries(resource,retries form)

Performs an ssi with some number of retries.  Retries continue either
until the result is ok or until the retry count supplied by the
caller is exhausted.  

Inputs:

=over 4

resource   - Identifies the resource to insert.

retries    - Count of the number of retries allowed.

form       - Hash that identifies the rendering options.

=back

Returns:

=over 4

content    - The content of the response.  If retries were exhausted this is empty.

response   - The response from the last attempt (which may or may not have been successful.

=back

=back

=cut

sub ssi_with_retries {
    my ($resource, $retries, %form) = @_;


    my $ok = 0;			# True if we got a good response.
    my $content;
    my $response;

    # Try to get the ssi done. within the retries count:

    do {
	($content, $response) = &Apache::lonnet::ssi($resource, %form);
	$ok      = $response->is_success;
        if (!$ok) {
            &Apache::lonnet::logthis("Failed ssi_with_retries on $resource: ".$response->is_success.', '.$response->code.', '.$response->message);
        }
	$retries--;
    } while (!$ok && ($retries > 0));

    if (!$ok) {
	$content = '';		# On error return an empty content.
    }
    return ($content, $response);

}



# ----------------------------------------------- Filetypes/Languages/Copyright
my %language;
my %supported_language;
my %cprtag;
my %scprtag;
my %fe; my %fd; my %fm;
my %category_extensions;

# ---------------------------------------------- Thesaurus variables
#
# %Keywords:
#      A hash used by &keyword to determine if a word is considered a keyword.
# $thesaurus_db_file 
#      Scalar containing the full path to the thesaurus database.

my %Keywords;
my $thesaurus_db_file;

#
# Initialize values from language.tab, copyright.tab, filetypes.tab,
# thesaurus.tab, and filecategories.tab.
#
BEGIN {
    # Variable initialization
    $thesaurus_db_file = $Apache::lonnet::perlvar{'lonTabDir'}."/thesaurus.db";
    #
    unless ($readit) {
# ------------------------------------------------------------------- languages
    {
        my $langtabfile = $Apache::lonnet::perlvar{'lonTabDir'}.
                                   '/language.tab';
        if ( open(my $fh,"<$langtabfile") ) {
            while (my $line = <$fh>) {
                next if ($line=~/^\#/);
                chomp($line);
                my ($key,$two,$country,$three,$enc,$val,$sup)=(split(/\t/,$line));
                $language{$key}=$val.' - '.$enc;
                if ($sup) {
                    $supported_language{$key}=$sup;
                }
            }
            close($fh);
        }
    }
# ------------------------------------------------------------------ copyrights
    {
        my $copyrightfile = $Apache::lonnet::perlvar{'lonIncludes'}.
                                  '/copyright.tab';
        if ( open (my $fh,"<$copyrightfile") ) {
            while (my $line = <$fh>) {
                next if ($line=~/^\#/);
                chomp($line);
                my ($key,$val)=(split(/\s+/,$line,2));
                $cprtag{$key}=$val;
            }
            close($fh);
        }
    }
# ----------------------------------------------------------- source copyrights
    {
        my $sourcecopyrightfile = $Apache::lonnet::perlvar{'lonIncludes'}.
                                  '/source_copyright.tab';
        if ( open (my $fh,"<$sourcecopyrightfile") ) {
            while (my $line = <$fh>) {
                next if ($line =~ /^\#/);
                chomp($line);
                my ($key,$val)=(split(/\s+/,$line,2));
                $scprtag{$key}=$val;
            }
            close($fh);
        }
    }

# -------------------------------------------------------------- default domain designs
    my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
    my $designfile = $designdir.'/default.tab';
    if ( open (my $fh,"<$designfile") ) {
        while (my $line = <$fh>) {
            next if ($line =~ /^\#/);
            chomp($line);
            my ($key,$val)=(split(/\=/,$line));
            if ($val) { $defaultdesign{$key}=$val; }
        }
        close($fh);
    }

# ------------------------------------------------------------- file categories
    {
        my $categoryfile = $Apache::lonnet::perlvar{'lonTabDir'}.
                                  '/filecategories.tab';
        if ( open (my $fh,"<$categoryfile") ) {
	    while (my $line = <$fh>) {
		next if ($line =~ /^\#/);
		chomp($line);
                my ($extension,$category)=(split(/\s+/,$line,2));
                push @{$category_extensions{lc($category)}},$extension;
            }
            close($fh);
        }

    }
# ------------------------------------------------------------------ file types
    {
        my $typesfile = $Apache::lonnet::perlvar{'lonTabDir'}.
               '/filetypes.tab';
        if ( open (my $fh,"<$typesfile") ) {
            while (my $line = <$fh>) {
		next if ($line =~ /^\#/);
		chomp($line);
                my ($ending,$emb,$mime,$descr)=split(/\s+/,$line,4);
                if ($descr ne '') {
                    $fe{$ending}=lc($emb);
                    $fd{$ending}=$descr;
                    if ($mime ne 'unk') { $fm{$ending}=$mime; }
                }
            }
            close($fh);
        }
    }
    &Apache::lonnet::logthis(
             "<span style='color:yellow;'>INFO: Read file types</span>");
    $readit=1;
    }  # end of unless($readit) 
    
}

###############################################################
##           HTML and Javascript Helper Functions            ##
###############################################################

=pod 

=head1 HTML and Javascript Functions

=over 4

=item * &browser_and_searcher_javascript()

X<browsing, javascript>X<searching, javascript>Returns a string
containing javascript with two functions, C<openbrowser> and
C<opensearcher>. Returned string does not contain E<lt>scriptE<gt>
tags.

=item * &openbrowser(formname,elementname,only,omit) [javascript]

inputs: formname, elementname, only, omit

formname and elementname indicate the name of the html form and name of
the element that the results of the browsing selection are to be placed in. 

Specifying 'only' will restrict the browser to displaying only files
with the given extension.  Can be a comma separated list.

Specifying 'omit' will restrict the browser to NOT displaying files
with the given extension.  Can be a comma separated list.

=item * &opensearcher(formname,elementname) [javascript]

Inputs: formname, elementname

formname and elementname specify the name of the html form and the name
of the element the selection from the search results will be placed in.

=cut

sub browser_and_searcher_javascript {
    my ($mode)=@_;
    if (!defined($mode)) { $mode='edit'; }
    my $resurl=&escape_single(&lastresurl());
    return <<END;
// <!-- BEGIN LON-CAPA Internal
    var editbrowser = null;
    function openbrowser(formname,elementname,only,omit,titleelement) {
        var url = '$resurl/?';
        if (editbrowser == null) {
            url += 'launch=1&';
        }
        url += 'catalogmode=interactive&';
        url += 'mode=$mode&';
        url += 'inhibitmenu=yes&';
        url += 'form=' + formname + '&';
        if (only != null) {
            url += 'only=' + only + '&';
        } else {
            url += 'only=&';
	}
        if (omit != null) {
            url += 'omit=' + omit + '&';
        } else {
            url += 'omit=&';
	}
        if (titleelement != null) {
            url += 'titleelement=' + titleelement + '&';
        } else {
	    url += 'titleelement=&';
	}
        url += 'element=' + elementname + '';
        var title = 'Browser';
        var options = 'scrollbars=1,resizable=1,menubar=0,toolbar=1,location=1';
        options += ',width=700,height=600';
        editbrowser = open(url,title,options,'1');
        editbrowser.focus();
    }
    var editsearcher;
    function opensearcher(formname,elementname,titleelement) {
        var url = '/adm/searchcat?';
        if (editsearcher == null) {
            url += 'launch=1&';
        }
        url += 'catalogmode=interactive&';
        url += 'mode=$mode&';
        url += 'form=' + formname + '&';
        if (titleelement != null) {
            url += 'titleelement=' + titleelement + '&';
        } else {
	    url += 'titleelement=&';
	}
        url += 'element=' + elementname + '';
        var title = 'Search';
        var options = 'scrollbars=1,resizable=1,menubar=0,toolbar=1,location=1';
        options += ',width=700,height=600';
        editsearcher = open(url,title,options,'1');
        editsearcher.focus();
    }
// END LON-CAPA Internal -->
END
}

sub lastresurl {
    if ($env{'environment.lastresurl'}) {
	return $env{'environment.lastresurl'}
    } else {
	return '/res';
    }
}

sub storeresurl {
    my $resurl=&Apache::lonnet::clutter(shift);
    unless ($resurl=~/^\/res/) { return 0; }
    $resurl=~s/\/$//;
    &Apache::lonnet::put('environment',{'lastresurl' => $resurl});
    &Apache::lonnet::appenv({'environment.lastresurl' => $resurl});
    return 1;
}

sub studentbrowser_javascript {
   unless (
            (($env{'request.course.id'}) && 
             (&Apache::lonnet::allowed('srm',$env{'request.course.id'})
	      || &Apache::lonnet::allowed('srm',$env{'request.course.id'}.
					  '/'.$env{'request.course.sec'})
	      ))
         || ($env{'request.role'}=~/^(au|dc|su)/)
          ) { return ''; }  
   return (<<'ENDSTDBRW');
<script type="text/javascript" language="Javascript">
// <![CDATA[
    var stdeditbrowser;
    function openstdbrowser(formname,uname,udom,roleflag,ignorefilter,courseadvonly) {
        var url = '/adm/pickstudent?';
        var filter;
	if (!ignorefilter) {
	    eval('filter=document.'+formname+'.'+uname+'.value;');
	}
        if (filter != null) {
           if (filter != '') {
               url += 'filter='+filter+'&';
	   }
        }
        url += 'form=' + formname + '&unameelement='+uname+
                                    '&udomelement='+udom;
	if (roleflag) { url+="&roles=1"; }
        if (courseadvonly) { url+="&courseadvonly=1"; }
        var title = 'Student_Browser';
        var options = 'scrollbars=1,resizable=1,menubar=0';
        options += ',width=700,height=600';
        stdeditbrowser = open(url,title,options,'1');
        stdeditbrowser.focus();
    }
// ]]>
</script>
ENDSTDBRW
}

sub selectstudent_link {
   my ($form,$unameele,$udomele,$courseadvonly)=@_;
   my $callargs = "'".$form."','".$unameele."','".$udomele."'";
   if ($env{'request.course.id'}) {  
       if (!&Apache::lonnet::allowed('srm',$env{'request.course.id'})
	   && !&Apache::lonnet::allowed('srm',$env{'request.course.id'}.
					'/'.$env{'request.course.sec'})) {
	   return '';
       }
       if ($courseadvonly)  {
           $callargs .= ",'',1,1";
       }
       return '<span class="LC_nobreak">'.
              '<a href="javascript:openstdbrowser('.$callargs.');">'.
              &mt('Select User').'</a></span>';
   }
   if ($env{'request.role'}=~/^(au|dc|su)/) {
       $callargs .= ",1"; 
       return '<span class="LC_nobreak">'.
              '<a href="javascript:openstdbrowser('.$callargs.');">'.
              &mt('Select User').'</a></span>';
   }
   return '';
}

sub authorbrowser_javascript {
    return <<"ENDAUTHORBRW";
<script type="text/javascript" language="JavaScript">
// <![CDATA[
var stdeditbrowser;

function openauthorbrowser(formname,udom) {
    var url = '/adm/pickauthor?';
    url += 'form='+formname+'&roledom='+udom;
    var title = 'Author_Browser';
    var options = 'scrollbars=1,resizable=1,menubar=0';
    options += ',width=700,height=600';
    stdeditbrowser = open(url,title,options,'1');
    stdeditbrowser.focus();
}

// ]]>
</script>
ENDAUTHORBRW
}

sub coursebrowser_javascript {
    my ($domainfilter,$sec_element,$formname,$role_element,$crstype) = @_;
    my $wintitle = 'Course_Browser';
    if ($crstype eq 'Community') {
        $wintitle = 'Community_Browser';
    }
    my $id_functions = &javascript_index_functions();
    my $output = '
<script type="text/javascript" language="JavaScript">
// <![CDATA[
    var stdeditbrowser;'."\n";

    $output .= <<"ENDSTDBRW";
    function opencrsbrowser(formname,uname,udom,desc,extra_element,multflag,type,type_elem) {
        var url = '/adm/pickcourse?';
        var formid = getFormIdByName(formname);
        var domainfilter = getDomainFromSelectbox(formname,udom);
        if (domainfilter != null) {
           if (domainfilter != '') {
               url += 'domainfilter='+domainfilter+'&';
	   }
        }
        url += 'form=' + formname + '&cnumelement='+uname+
	                            '&cdomelement='+udom+
                                    '&cnameelement='+desc;
        if (extra_element !=null && extra_element != '') {
            if (formname == 'rolechoice' || formname == 'studentform') {
                url += '&roleelement='+extra_element;
                if (domainfilter == null || domainfilter == '') {
                    url += '&domainfilter='+extra_element;
                }
            }
            else {
                if (formname == 'portform') {
                    url += '&setroles='+extra_element;
                } else {
                    if (formname == 'rules') {
                        url += '&fixeddom='+extra_element; 
                    }
                }
            }     
        }
        if (type != null && type != '') {
            url += '&type='+type;
        }
        if (type_elem != null && type_elem != '') {
            url += '&typeelement='+type_elem;
        }
        if (formname == 'ccrs') {
            var ownername = document.forms[formid].ccuname.value;
            var ownerdom =  document.forms[formid].ccdomain.options[document.forms[formid].ccdomain.selectedIndex].value;
            url += '&cloner='+ownername+':'+ownerdom;
        }
        if (multflag !=null && multflag != '') {
            url += '&multiple='+multflag;
        }
        var title = '$wintitle';
        var options = 'scrollbars=1,resizable=1,menubar=0';
        options += ',width=700,height=600';
        stdeditbrowser = open(url,title,options,'1');
        stdeditbrowser.focus();
    }
$id_functions
ENDSTDBRW
    if (($sec_element ne '') || ($role_element ne '')) {
        $output .= &setsec_javascript($sec_element,$formname,$role_element);
    }
    $output .= '
// ]]>
</script>';
    return $output;
}

sub javascript_index_functions {
    return <<"ENDJS";

function getFormIdByName(formname) {
    for (var i=0;i<document.forms.length;i++) {
        if (document.forms[i].name == formname) {
            return i;
        }
    }
    return -1;
}

function getIndexByName(formid,item) {
    for (var i=0;i<document.forms[formid].elements.length;i++) {
        if (document.forms[formid].elements[i].name == item) {
            return i;
        }
    }
    return -1;
}

function getDomainFromSelectbox(formname,udom) {
    var userdom;
    var formid = getFormIdByName(formname);
    if (formid > -1) {
        var domid = getIndexByName(formid,udom);
        if (domid > -1) {
            if (document.forms[formid].elements[domid].type == 'select-one') {
                userdom=document.forms[formid].elements[domid].options[document.forms[formid].elements[domid].selectedIndex].value;
            }
            if (document.forms[formid].elements[domid].type == 'hidden') {
                userdom=document.forms[formid].elements[domid].value;
            }
        }
    }
    return userdom;
}

ENDJS

}

sub userbrowser_javascript {
    my $id_functions = &javascript_index_functions();
    return <<"ENDUSERBRW";

function openuserbrowser(formname,uname,udom,ulast,ufirst,uemail,hideudom,crsdom,caller) {
    var url = '/adm/pickuser?';
    var userdom = getDomainFromSelectbox(formname,udom);
    if (userdom != null) {
       if (userdom != '') {
           url += 'srchdom='+userdom+'&';
       }
    }
    url += 'form=' + formname + '&unameelement='+uname+
                                '&udomelement='+udom+
                                '&ulastelement='+ulast+
                                '&ufirstelement='+ufirst+
                                '&uemailelement='+uemail+
                                '&hideudomelement='+hideudom+
                                '&coursedom='+crsdom;
    if ((caller != null) && (caller != undefined)) {
        url += '&caller='+caller;
    }
    var title = 'User_Browser';
    var options = 'scrollbars=1,resizable=1,menubar=0';
    options += ',width=700,height=600';
    var stdeditbrowser = open(url,title,options,'1');
    stdeditbrowser.focus();
}

function fix_domain (formname,udom,origdom,uname) {
    var formid = getFormIdByName(formname);
    if (formid > -1) {
        var unameid = getIndexByName(formid,uname);
        var domid = getIndexByName(formid,udom);
        var hidedomid = getIndexByName(formid,origdom);
        if (hidedomid > -1) {
            var fixeddom = document.forms[formid].elements[hidedomid].value;
            var unameval = document.forms[formid].elements[unameid].value;
            if ((fixeddom != '') && (fixeddom != undefined) && (fixeddom != null) && (unameval != '') && (unameval != undefined) && (unameval != null)) {
                if (domid > -1) {
                    var slct = document.forms[formid].elements[domid];
                    if (slct.type == 'select-one') {
                        var i;
                        for (i=0;i<slct.length;i++) {
                            if (slct.options[i].value==fixeddom) { slct.selectedIndex=i; }
                        }
                    }
                    if (slct.type == 'hidden') {
                        slct.value = fixeddom;
                    }
                }
            }
        }
    }
    return;
}

$id_functions
ENDUSERBRW
}

sub setsec_javascript {
    my ($sec_element,$formname,$role_element) = @_;
    my (@courserolenames,@communityrolenames,$rolestr,$courserolestr,
        $communityrolestr);
    if ($role_element ne '') {
        my @allroles = ('st','ta','ep','in','ad');
        foreach my $crstype ('Course','Community') {
            if ($crstype eq 'Community') {
                foreach my $role (@allroles) {
                    push(@communityrolenames,&Apache::lonnet::plaintext($role,$crstype));
                }
                push(@communityrolenames,&Apache::lonnet::plaintext('co'));
            } else {
                foreach my $role (@allroles) {
                    push(@courserolenames,&Apache::lonnet::plaintext($role,$crstype));
                }
                push(@courserolenames,&Apache::lonnet::plaintext('cc'));
            }
        }
        $rolestr = '"'.join('","',@allroles).'"';
        $courserolestr = '"'.join('","',@courserolenames).'"';
        $communityrolestr = '"'.join('","',@communityrolenames).'"';
    }
    my $setsections = qq|
function setSect(sectionlist) {
    var sectionsArray = new Array();
    if ((sectionlist != '') && (typeof sectionlist != "undefined")) {
        sectionsArray = sectionlist.split(",");
    }
    var numSections = sectionsArray.length;
    document.$formname.$sec_element.length = 0;
    if (numSections == 0) {
        document.$formname.$sec_element.multiple=false;
        document.$formname.$sec_element.size=1;
        document.$formname.$sec_element.options[0] = new Option('No existing sections','',false,false)
    } else {
        if (numSections == 1) {
            document.$formname.$sec_element.multiple=false;
            document.$formname.$sec_element.size=1;
            document.$formname.$sec_element.options[0] = new Option('Select','',true,true);
            document.$formname.$sec_element.options[1] = new Option('No section','',false,false)
            document.$formname.$sec_element.options[2] = new Option(sectionsArray[0],sectionsArray[0],false,false);
        } else {
            for (var i=0; i<numSections; i++) {
                document.$formname.$sec_element.options[i] = new Option(sectionsArray[i],sectionsArray[i],false,false)
            }
            document.$formname.$sec_element.multiple=true
            if (numSections < 3) {
                document.$formname.$sec_element.size=numSections;
            } else {
                document.$formname.$sec_element.size=3;
            }
            document.$formname.$sec_element.options[0].selected = false
        }
    }
}

function setRole(crstype) {
|;
    if ($role_element eq '') {
        $setsections .= '    return;
}
';
    } else {
        $setsections .= qq|
    var elementLength = document.$formname.$role_element.length;
    var allroles = Array($rolestr);
    var courserolenames = Array($courserolestr);
    var communityrolenames = Array($communityrolestr);
    if (elementLength != undefined) {
        if (document.$formname.$role_element.options[5].value == 'cc') {
            if (crstype == 'Course') {
                return;
            } else {
                allroles[5] = 'co';
                for (var i=0; i<6; i++) {
                    document.$formname.$role_element.options[i].value = allroles[i];
                    document.$formname.$role_element.options[i].text = communityrolenames[i];
                }
            }
        } else {
            if (crstype == 'Community') {
                return;
            } else {
                allroles[5] = 'cc';
                for (var i=0; i<6; i++) {
                    document.$formname.$role_element.options[i].value = allroles[i];
                    document.$formname.$role_element.options[i].text = courserolenames[i];
                }
            }
        }
    }
    return;
}
|;
    }
    return $setsections;
}

sub selectcourse_link {
   my ($form,$unameele,$udomele,$desc,$extra_element,$multflag,$selecttype,
       $typeelement) = @_;
   my $type = $selecttype;
   my $linktext = &mt('Select Course');
   if ($selecttype eq 'Community') {
       $linktext = &mt('Select Community');
   } elsif ($selecttype eq 'Course/Community') {
       $linktext = &mt('Select Course/Community');
       $type = '';
   }
   return '<span class="LC_nobreak">'
         ."<a href='"
         .'javascript:opencrsbrowser("'.$form.'","'.$unameele
         .'","'.$udomele.'","'.$desc.'","'.$extra_element
         .'","'.$multflag.'","'.$type.'","'.$typeelement.'");'
         ."'>".$linktext.'</a>'
         .'</span>';
}

sub selectauthor_link {
   my ($form,$udom)=@_;
   return '<a href="javascript:openauthorbrowser('."'$form','$udom'".');">'.
          &mt('Select Author').'</a>';
}

sub selectuser_link {
    my ($form,$unameelem,$domelem,$lastelem,$firstelem,$emailelem,$hdomelem,
        $coursedom,$linktext,$caller) = @_;
    return '<a href="javascript:openuserbrowser('."'$form','$unameelem','$domelem',".
           "'$lastelem','$firstelem','$emailelem','$hdomelem','$coursedom','$caller'".
           ');">'.$linktext.'</a>';
}

sub check_uncheck_jscript {
    my $jscript = <<"ENDSCRT";
function checkAll(field) {
    if (field.length > 0) {
        for (i = 0; i < field.length; i++) {
            field[i].checked = true ;
        }
    } else {
        field.checked = true
    }
}
 
function uncheckAll(field) {
    if (field.length > 0) {
        for (i = 0; i < field.length; i++) {
            field[i].checked = false ;
        }
    } else {
        field.checked = false ;
    }
}
ENDSCRT
    return $jscript;
}

sub select_timezone {
   my ($name,$selected,$onchange,$includeempty)=@_;
   my $output='<select name="'.$name.'" '.$onchange.'>'."\n";
   if ($includeempty) {
       $output .= '<option value=""';
       if (($selected eq '') || ($selected eq 'local')) {
           $output .= ' selected="selected" ';
       }
       $output .= '> </option>';
   }
   my @timezones = DateTime::TimeZone->all_names;
   foreach my $tzone (@timezones) {
       $output.= '<option value="'.$tzone.'"';
       if ($tzone eq $selected) {
           $output.=' selected="selected"';
       }
       $output.=">$tzone</option>\n";
   }
   $output.="</select>";
   return $output;
}

sub select_datelocale {
    my ($name,$selected,$onchange,$includeempty)=@_;
    my $output='<select name="'.$name.'" '.$onchange.'>'."\n";
    if ($includeempty) {
        $output .= '<option value=""';
        if ($selected eq '') {
            $output .= ' selected="selected" ';
        }
        $output .= '> </option>';
    }
    my (@possibles,%locale_names);
    my @locales = DateTime::Locale::Catalog::Locales;
    foreach my $locale (@locales) {
        if (ref($locale) eq 'HASH') {
            my $id = $locale->{'id'};
            if ($id ne '') {
                my $en_terr = $locale->{'en_territory'};
                my $native_terr = $locale->{'native_territory'};
                my @languages = &Apache::lonlocal::preferred_languages();
                if (grep(/^en$/,@languages) || !@languages) {
                    if ($en_terr ne '') {
                        $locale_names{$id} = '('.$en_terr.')';
                    } elsif ($native_terr ne '') {
                        $locale_names{$id} = $native_terr;
                    }
                } else {
                    if ($native_terr ne '') {
                        $locale_names{$id} = $native_terr.' ';
                    } elsif ($en_terr ne '') {
                        $locale_names{$id} = '('.$en_terr.')';
                    }
                }
                push (@possibles,$id);
            }
        }
    }
    foreach my $item (sort(@possibles)) {
        $output.= '<option value="'.$item.'"';
        if ($item eq $selected) {
            $output.=' selected="selected"';
        }
        $output.=">$item";
        if ($locale_names{$item} ne '') {
            $output.="  $locale_names{$item}</option>\n";
        }
        $output.="</option>\n";
    }
    $output.="</select>";
    return $output;
}

sub select_language {
    my ($name,$selected,$includeempty) = @_;
    my %langchoices;
    if ($includeempty) {
        %langchoices = ('' => 'No language preference');
    }
    foreach my $id (&languageids()) {
        my $code = &supportedlanguagecode($id);
        if ($code) {
            $langchoices{$code} = &plainlanguagedescription($id);
        }
    }
    return &select_form($selected,$name,\%langchoices);
}

=pod

=item * &linked_select_forms(...)

linked_select_forms returns a string containing a <script></script> block
and html for two <select> menus.  The select menus will be linked in that
changing the value of the first menu will result in new values being placed
in the second menu.  The values in the select menu will appear in alphabetical
order unless a defined order is provided.

linked_select_forms takes the following ordered inputs:

=over 4

=item * $formname, the name of the <form> tag

=item * $middletext, the text which appears between the <select> tags

=item * $firstdefault, the default value for the first menu

=item * $firstselectname, the name of the first <select> tag

=item * $secondselectname, the name of the second <select> tag

=item * $hashref, a reference to a hash containing the data for the menus.

=item * $menuorder, the order of values in the first menu

=back 

Below is an example of such a hash.  Only the 'text', 'default', and 
'select2' keys must appear as stated.  keys(%menu) are the possible 
values for the first select menu.  The text that coincides with the 
first menu value is given in $menu{$choice1}->{'text'}.  The values 
and text for the second menu are given in the hash pointed to by 
$menu{$choice1}->{'select2'}.  

 my %menu = ( A1 => { text =>"Choice A1" ,
                       default => "B3",
                       select2 => { 
                           B1 => "Choice B1",
                           B2 => "Choice B2",
                           B3 => "Choice B3",
                           B4 => "Choice B4"
                           },
                       order => ['B4','B3','B1','B2'],
                   },
               A2 => { text =>"Choice A2" ,
                       default => "C2",
                       select2 => { 
                           C1 => "Choice C1",
                           C2 => "Choice C2",
                           C3 => "Choice C3"
                           },
                       order => ['C2','C1','C3'],
                   },
               A3 => { text =>"Choice A3" ,
                       default => "D6",
                       select2 => { 
                           D1 => "Choice D1",
                           D2 => "Choice D2",
                           D3 => "Choice D3",
                           D4 => "Choice D4",
                           D5 => "Choice D5",
                           D6 => "Choice D6",
                           D7 => "Choice D7"
                           },
                       order => ['D4','D3','D2','D1','D7','D6','D5'],
                   }
               );

=cut

sub linked_select_forms {
    my ($formname,
        $middletext,
        $firstdefault,
        $firstselectname,
        $secondselectname, 
        $hashref,
        $menuorder,
        ) = @_;
    my $second = "document.$formname.$secondselectname";
    my $first = "document.$formname.$firstselectname";
    # output the javascript to do the changing
    my $result = '';
    $result.='<script type="text/javascript" language="JavaScript">'."\n";
    $result.="// <![CDATA[\n";
    $result.="var select2data = new Object();\n";
    $" = '","';
    my $debug = '';
    foreach my $s1 (sort(keys(%$hashref))) {
        $result.="select2data.d_$s1 = new Object();\n";        
        $result.="select2data.d_$s1.def = new String('".
            $hashref->{$s1}->{'default'}."');\n";
        $result.="select2data.d_$s1.values = new Array(";
        my @s2values = sort(keys( %{ $hashref->{$s1}->{'select2'} } ));
        if (ref($hashref->{$s1}->{'order'}) eq 'ARRAY') {
            @s2values = @{$hashref->{$s1}->{'order'}};
        }
        $result.="\"@s2values\");\n";
        $result.="select2data.d_$s1.texts = new Array(";        
        my @s2texts;
        foreach my $value (@s2values) {
            push @s2texts, $hashref->{$s1}->{'select2'}->{$value};
        }
        $result.="\"@s2texts\");\n";
    }
    $"=' ';
    $result.= <<"END";

function select1_changed() {
    // Determine new choice
    var newvalue = "d_" + $first.value;
    // update select2
    var values     = select2data[newvalue].values;
    var texts      = select2data[newvalue].texts;
    var select2def = select2data[newvalue].def;
    var i;
    // out with the old
    for (i = 0; i < $second.options.length; i++) {
        $second.options[i] = null;
    }
    // in with the nuclear
    for (i=0;i<values.length; i++) {
        $second.options[i] = new Option(values[i]);
        $second.options[i].value = values[i];
        $second.options[i].text = texts[i];
        if (values[i] == select2def) {
            $second.options[i].selected = true;
        }
    }
}
// ]]>
</script>
END
    # output the initial values for the selection lists
    $result .= "<select size=\"1\" name=\"$firstselectname\" onchange=\"select1_changed()\">\n";
    my @order = sort(keys(%{$hashref}));
    if (ref($menuorder) eq 'ARRAY') {
        @order = @{$menuorder};
    }
    foreach my $value (@order) {
        $result.="    <option value=\"$value\" ";
        $result.=" selected=\"selected\" " if ($value eq $firstdefault);
        $result.=">".&mt($hashref->{$value}->{'text'})."</option>\n";
    }
    $result .= "</select>\n";
    my %select2 = %{$hashref->{$firstdefault}->{'select2'}};
    $result .= $middletext;
    $result .= "<select size=\"1\" name=\"$secondselectname\">\n";
    my $seconddefault = $hashref->{$firstdefault}->{'default'};
    
    my @secondorder = sort(keys(%select2));
    if (ref($hashref->{$firstdefault}->{'order'}) eq 'ARRAY') {
        @secondorder = @{$hashref->{$firstdefault}->{'order'}};
    }
    foreach my $value (@secondorder) {
        $result.="    <option value=\"$value\" ";        
        $result.=" selected=\"selected\" " if ($value eq $seconddefault);
        $result.=">".&mt($select2{$value})."</option>\n";
    }
    $result .= "</select>\n";
    #    return $debug;
    return $result;
}   #  end of sub linked_select_forms {

=pod

=item * &help_open_topic($topic,$text,$stayOnPage,$width,$height,$imgid)

Returns a string corresponding to an HTML link to the given help
$topic, where $topic corresponds to the name of a .tex file in
/home/httpd/html/adm/help/tex, with underscores replaced by
spaces. 

$text will optionally be linked to the same topic, allowing you to
link text in addition to the graphic. If you do not want to link
text, but wish to specify one of the later parameters, pass an
empty string. 

$stayOnPage is a value that will be interpreted as a boolean. If true,
the link will not open a new window. If false, the link will open
a new window using Javascript. (Default is false.) 

$width and $height are optional numerical parameters that will
override the width and height of the popped up window, which may
be useful for certain help topics with big pictures included.

$imgid is the id of the img tag used for the help icon. This may be
used in a javascript call to switch the image src.  See 
lonhtmlcommon::htmlareaselectactive() for an example.

=cut

sub help_open_topic {
    my ($topic, $text, $stayOnPage, $width, $height, $imgid) = @_;
    $text = "" if (not defined $text);
    $stayOnPage = 0 if (not defined $stayOnPage);
    $width = 350 if (not defined $width);
    $height = 400 if (not defined $height);
    my $filename = $topic;
    $filename =~ s/ /_/g;

    my $template = "";
    my $link;
    
    $topic=~s/\W/\_/g;

    if (!$stayOnPage) {
	$link = "javascript:void(open('/adm/help/${filename}.hlp', 'Help_for_$topic', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
    } else {
	$link = "/adm/help/${filename}.hlp";
    }

    # Add the text
    if ($text ne "") {	
	$template.='<span class="LC_help_open_topic">'
                  .'<a target="_top" href="'.$link.'">'
                  .$text.'</a>';
    }

    # (Always) Add the graphic
    my $title = &mt('Online Help');
    my $helpicon=&lonhttpdurl("/adm/help/help.png");
    if ($imgid ne '') {
        $imgid = ' id="'.$imgid.'"';
    }
    $template.=' <a target="_top" href="'.$link.'" title="'.$title.'">'
              .'<img src="'.$helpicon.'" border="0"'
              .' alt="'.&mt('Help: [_1]',$topic).'"'
              .' title="'.$title.'" style="vertical-align:middle;"'.$imgid 
              .' /></a>';
    if ($text ne "") {	
        $template.='</span>';
    }
    return $template;

}

# This is a quicky function for Latex cheatsheet editing, since it 
# appears in at least four places
sub helpLatexCheatsheet {
    my ($topic,$text,$not_author) = @_;
    my $out;
    my $addOther = '';
    if ($topic) {
	$addOther = '<span>'.&Apache::loncommon::help_open_topic($topic,&mt($text),
							       undef, undef, 600).
								   '</span> ';
    }
    $out = '<span>' # Start cheatsheet
	  .$addOther
          .'<span>'
	  .&Apache::loncommon::help_open_topic('Greek_Symbols',&mt('Greek Symbols'),
					       undef,undef,600)
	  .'</span> <span>'
	  .&Apache::loncommon::help_open_topic('Other_Symbols',&mt('Other Symbols'),
					       undef,undef,600)
	  .'</span>';
    unless ($not_author) {
        $out .= ' <span>'
	       .&Apache::loncommon::help_open_topic('Authoring_Output_Tags',&mt('Output Tags'),
	                                            undef,undef,600)
	       .'</span>';
    }
    $out .= '</span>'; # End cheatsheet
    return $out;
}

sub general_help {
    my $helptopic='Student_Intro';
    if ($env{'request.role'}=~/^(ca|au)/) {
	$helptopic='Authoring_Intro';
    } elsif ($env{'request.role'}=~/^(cc|co)/) {
	$helptopic='Course_Coordination_Intro';
    } elsif ($env{'request.role'}=~/^dc/) {
        $helptopic='Domain_Coordination_Intro';
    }
    return $helptopic;
}

sub update_help_link {
    my ($topic,$component_help,$faq,$bug,$stayOnPage) = @_;
    my $origurl = $ENV{'REQUEST_URI'};
    $origurl=~s|^/~|/priv/|;
    my $timestamp = time;
    foreach my $datum (\$topic,\$component_help,\$faq,\$bug,\$origurl) {
        $$datum = &escape($$datum);
    }

    my $banner_link = "/adm/helpmenu?page=banner&amp;topic=$topic&amp;component_help=$component_help&amp;faq=$faq&amp;bug=$bug&amp;origurl=$origurl&amp;stamp=$timestamp&amp;stayonpage=$stayOnPage";
    my $output .= <<"ENDOUTPUT";
<script type="text/javascript">
// <![CDATA[
banner_link = '$banner_link';
// ]]>
</script>
ENDOUTPUT
    return $output;
}

# now just updates the help link and generates a blue icon
sub help_open_menu {
    my ($topic,$component_help,$faq,$bug,$stayOnPage,$width,$height,$text) 
	= @_;    
    $stayOnPage = 1;
    my $output;
    if ($component_help) {
	if (!$text) {
	    $output=&help_open_topic($component_help,undef,$stayOnPage,
				       $width,$height);
	} else {
	    my $help_text;
	    $help_text=&unescape($topic);
	    $output='<table><tr><td>'.
		&help_open_topic($component_help,$help_text,$stayOnPage,
				 $width,$height).'</td></tr></table>';
	}
    }
    my $banner_link = &update_help_link($topic,$component_help,$faq,$bug,$stayOnPage);
    return $output.$banner_link;
}

sub top_nav_help {
    my ($text) = @_;
    $text = &mt($text);
    my $stay_on_page = 1;

    my $link = ($stay_on_page) ? "javascript:helpMenu('display')"
	                     : "javascript:helpMenu('open')";
    my $banner_link = &update_help_link(undef,undef,undef,undef,$stay_on_page);

    my $title = &mt('Get help');

    return <<"END";
$banner_link
 <a href="$link" title="$title">$text</a>
END
}

sub help_menu_js {
    my ($text) = @_;
    my $stayOnPage = 1;
    my $width = 620;
    my $height = 600;
    my $helptopic=&general_help();
    my $details_link = '/adm/help/'.$helptopic.'.hlp';
    my $nothing=&Apache::lonhtmlcommon::javascript_nothing();
    my $start_page =
        &Apache::loncommon::start_page('Help Menu', undef,
				       {'frameset'    => 1,
					'js_ready'    => 1,
					'add_entries' => {
					    'border' => '0',
					    'rows'   => "110,*",},});
    my $end_page =
        &Apache::loncommon::end_page({'frameset' => 1,
				      'js_ready' => 1,});

    my $template .= <<"ENDTEMPLATE";
<script type="text/javascript">
// <![CDATA[
// <!-- BEGIN LON-CAPA Internal
var banner_link = '';
function helpMenu(target) {
    var caller = this;
    if (target == 'open') {
        var newWindow = null;
        try {
            newWindow =  window.open($nothing,"helpmenu","HEIGHT=$height,WIDTH=$width,resizable=yes,scrollbars=yes" )
        }
        catch(error) {
            writeHelp(caller);
            return;
        }
        if (newWindow) {
            caller = newWindow;
        }
    }
    writeHelp(caller);
    return;
}
function writeHelp(caller) {
    caller.document.writeln('$start_page<frame name="bannerframe"  src="'+banner_link+'" /><frame name="bodyframe" src="$details_link" /> $end_page')
    caller.document.close()
    caller.focus()
}
// END LON-CAPA Internal -->
// ]]>
</script>
ENDTEMPLATE
    return $template;
}

sub help_open_bug {
    my ($topic, $text, $stayOnPage, $width, $height) = @_;
    unless ($env{'user.adv'}) { return ''; }
    unless ($Apache::lonnet::perlvar{'BugzillaHost'}) { return ''; }
    $text = "" if (not defined $text);
	$stayOnPage=1;
    $width = 600 if (not defined $width);
    $height = 600 if (not defined $height);

    $topic=~s/\W+/\+/g;
    my $link='';
    my $template='';
    my $url=$Apache::lonnet::perlvar{'BugzillaHost'}.'enter_bug.cgi?product=LON-CAPA&amp;bug_file_loc='.
	&escape($ENV{'REQUEST_URI'}).'&amp;component='.$topic;
    if (!$stayOnPage)
    {
	$link = "javascript:void(open('$url', 'Bugzilla', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
    }
    else
    {
	$link = $url;
    }
    # Add the text
    if ($text ne "")
    {
	$template .= 
  "<table bgcolor='#AA3333' cellspacing='1' cellpadding='1' border='0'><tr>".
  "<td bgcolor='#FF5555'><a target=\"_top\" href=\"$link\"><span style=\"color:#FFFFFF;font-size:10pt;\">$text</span></a>";
    }

    # Add the graphic
    my $title = &mt('Report a Bug');
    my $bugicon=&lonhttpdurl("/adm/lonMisc/smallBug.gif");
    $template .= <<"ENDTEMPLATE";
 <a target="_top" href="$link" title="$title"><img src="$bugicon" border="0" alt="(Bug: $topic)" /></a>
ENDTEMPLATE
    if ($text ne '') { $template.='</td></tr></table>' };
    return $template;

}

sub help_open_faq {
    my ($topic, $text, $stayOnPage, $width, $height) = @_;
    unless ($env{'user.adv'}) { return ''; }
    unless ($Apache::lonnet::perlvar{'FAQHost'}) { return ''; }
    $text = "" if (not defined $text);
	$stayOnPage=1;
    $width = 350 if (not defined $width);
    $height = 400 if (not defined $height);

    $topic=~s/\W+/\+/g;
    my $link='';
    my $template='';
    my $url=$Apache::lonnet::perlvar{'FAQHost'}.'/fom/cache/'.$topic.'.html';
    if (!$stayOnPage)
    {
	$link = "javascript:void(open('$url', 'FAQ-O-Matic', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
    }
    else
    {
	$link = $url;
    }

    # Add the text
    if ($text ne "")
    {
	$template .= 
  "<table bgcolor='#337733' cellspacing='1' cellpadding='1' border='0'><tr>".
  "<td bgcolor='#448844'><a target=\"_top\" href=\"$link\"><span style=\"color:#FFFFFF; font-size:10pt;\">$text</span></a>";
    }

    # Add the graphic
    my $title = &mt('View the FAQ');
    my $faqicon=&lonhttpdurl("/adm/lonMisc/smallFAQ.gif");
    $template .= <<"ENDTEMPLATE";
 <a target="_top" href="$link" title="$title"><img src="$faqicon" border="0" alt="(FAQ: $topic)" /></a>
ENDTEMPLATE
    if ($text ne '') { $template.='</td></tr></table>' };
    return $template;

}

###############################################################
###############################################################

=pod

=item * &change_content_javascript():

This and the next function allow you to create small sections of an
otherwise static HTML page that you can update on the fly with
Javascript, even in Netscape 4.

The Javascript fragment returned by this function (no E<lt>scriptE<gt> tag)
must be written to the HTML page once. It will prove the Javascript
function "change(name, content)". Calling the change function with the
name of the section 
you want to update, matching the name passed to C<changable_area>, and
the new content you want to put in there, will put the content into
that area.

B<Note>: Netscape 4 only reserves enough space for the changable area
to contain room for the original contents. You need to "make space"
for whatever changes you wish to make, and be B<sure> to check your
code in Netscape 4. This feature in Netscape 4 is B<not> powerful;
it's adequate for updating a one-line status display, but little more.
This script will set the space to 100% width, so you only need to
worry about height in Netscape 4.

Modern browsers are much less limiting, and if you can commit to the
user not using Netscape 4, this feature may be used freely with
pretty much any HTML.

=cut

sub change_content_javascript {
    # If we're on Netscape 4, we need to use Layer-based code
    if ($env{'browser.type'} eq 'netscape' &&
	$env{'browser.version'} =~ /^4\./) {
	return (<<NETSCAPE4);
	function change(name, content) {
	    doc = document.layers[name+"___escape"].layers[0].document;
	    doc.open();
	    doc.write(content);
	    doc.close();
	}
NETSCAPE4
    } else {
	# Otherwise, we need to use semi-standards-compliant code
	# (technically, "innerHTML" isn't standard but the equivalent
	# is really scary, and every useful browser supports it
	return (<<DOMBASED);
	function change(name, content) {
	    element = document.getElementById(name);
	    element.innerHTML = content;
	}
DOMBASED
    }
}

=pod

=item * &changable_area($name,$origContent):

This provides a "changable area" that can be modified on the fly via
the Javascript code provided in C<change_content_javascript>. $name is
the name you will use to reference the area later; do not repeat the
same name on a given HTML page more then once. $origContent is what
the area will originally contain, which can be left blank.

=cut

sub changable_area {
    my ($name, $origContent) = @_;

    if ($env{'browser.type'} eq 'netscape' &&
	$env{'browser.version'} =~ /^4\./) {
	# If this is netscape 4, we need to use the Layer tag
	return "<ilayer width='100%' id='${name}___escape' overflow='none'><layer width='100%' id='$name' overflow='none'>$origContent</layer></ilayer>";
    } else {
	return "<span id='$name'>$origContent</span>";
    }
}

=pod

=item * &viewport_geometry_js 

Provides javascript object (Geometry) which can provide information about the viewport geometry for the client browser.

=cut


sub viewport_geometry_js { 
    return <<"GEOMETRY";
var Geometry = {};
function init_geometry() {
    if (Geometry.init) { return };
    Geometry.init=1;
    if (window.innerHeight) {
        Geometry.getViewportHeight   = function() { return window.innerHeight; };
        Geometry.getViewportWidth   = function() { return window.innerWidth; };
        Geometry.getHorizontalScroll = function() { return window.pageXOffset; };
        Geometry.getVerticalScroll   = function() { return window.pageYOffset; };
    }
    else if (document.documentElement && document.documentElement.clientHeight) {
        Geometry.getViewportHeight =
            function() { return document.documentElement.clientHeight; };
        Geometry.getViewportWidth =
            function() { return document.documentElement.clientWidth; };

        Geometry.getHorizontalScroll =
            function() { return document.documentElement.scrollLeft; };
        Geometry.getVerticalScroll =
            function() { return document.documentElement.scrollTop; };
    }
    else if (document.body.clientHeight) {
        Geometry.getViewportHeight =
            function() { return document.body.clientHeight; };
        Geometry.getViewportWidth =
            function() { return document.body.clientWidth; };
        Geometry.getHorizontalScroll =
            function() { return document.body.scrollLeft; };
        Geometry.getVerticalScroll =
            function() { return document.body.scrollTop; };
    }
}

GEOMETRY
}

=pod

=item * &viewport_size_js()

Provides a javascript function to set values of two form elements - width and height (elements are passed in as arguments to the javascript function) to the dimensions of the user's browser window. 

=cut

sub viewport_size_js {
    my $geometry = &viewport_geometry_js();
    return <<"DIMS";

$geometry

function getViewportDims(width,height) {
    init_geometry();
    width.value = Geometry.getViewportWidth();
    height.value = Geometry.getViewportHeight();
    return;
}

DIMS
}

=pod

=item * &resize_textarea_js()

emits the needed javascript to resize a textarea to be as big as possible

creates a function resize_textrea that takes two IDs first should be
the id of the element to resize, second should be the id of a div that
surrounds everything that comes after the textarea, this routine needs
to be attached to the <body> for the onload and onresize events.

=back

=cut

sub resize_textarea_js {
    my $geometry = &viewport_geometry_js();
    return <<"RESIZE";
    <script type="text/javascript">
// <![CDATA[
$geometry

function getX(element) {
    var x = 0;
    while (element) {
	x += element.offsetLeft;
	element = element.offsetParent;
    }
    return x;
}
function getY(element) {
    var y = 0;
    while (element) {
	y += element.offsetTop;
	element = element.offsetParent;
    }
    return y;
}


function resize_textarea(textarea_id,bottom_id) {
    init_geometry();
    var textarea        = document.getElementById(textarea_id);
    //alert(textarea);

    var textarea_top    = getY(textarea);
    var textarea_height = textarea.offsetHeight;
    var bottom          = document.getElementById(bottom_id);
    var bottom_top      = getY(bottom);
    var bottom_height   = bottom.offsetHeight;
    var window_height   = Geometry.getViewportHeight();
    var fudge           = 23;
    var new_height      = window_height-fudge-textarea_top-bottom_height;
    if (new_height < 300) {
	new_height = 300;
    }
    textarea.style.height=new_height+'px';
}
// ]]>
</script>
RESIZE

}

=pod

=head1 Excel and CSV file utility routines

=over 4

=cut

###############################################################
###############################################################

=pod

=item * &csv_translate($text) 

Translate $text to allow it to be output as a 'comma separated values' 
format.

=cut

###############################################################
###############################################################
sub csv_translate {
    my $text = shift;
    $text =~ s/\"/\"\"/g;
    $text =~ s/\n/ /g;
    return $text;
}

###############################################################
###############################################################

=pod

=item * &define_excel_formats()

Define some commonly used Excel cell formats.

Currently supported formats:

=over 4

=item header

=item bold

=item h1

=item h2

=item h3

=item h4

=item i

=item date

=back

Inputs: $workbook

Returns: $format, a hash reference.

=cut

###############################################################
###############################################################
sub define_excel_formats {
    my ($workbook) = @_;
    my $format;
    $format->{'header'} = $workbook->add_format(bold      => 1, 
                                                bottom    => 1,
                                                align     => 'center');
    $format->{'bold'} = $workbook->add_format(bold=>1);
    $format->{'h1'}   = $workbook->add_format(bold=>1, size=>18);
    $format->{'h2'}   = $workbook->add_format(bold=>1, size=>16);
    $format->{'h3'}   = $workbook->add_format(bold=>1, size=>14);
    $format->{'h4'}   = $workbook->add_format(bold=>1, size=>12);
    $format->{'i'}    = $workbook->add_format(italic=>1);
    $format->{'date'} = $workbook->add_format(num_format=>
                                            'mm/dd/yyyy hh:mm:ss');
    return $format;
}

###############################################################
###############################################################

=pod

=item * &create_workbook()

Create an Excel worksheet.  If it fails, output message on the
request object and return undefs.

Inputs: Apache request object

Returns (undef) on failure, 
    Excel worksheet object, scalar with filename, and formats 
    from &Apache::loncommon::define_excel_formats on success

=cut

###############################################################
###############################################################
sub create_workbook {
    my ($r) = @_;
        #
    # Create the excel spreadsheet
    my $filename = '/prtspool/'.
        $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
        time.'_'.rand(1000000000).'.xls';
    my $workbook  = Spreadsheet::WriteExcel->new('/home/httpd'.$filename);
    if (! defined($workbook)) {
        $r->log_error("Error creating excel spreadsheet $filename: $!");
        $r->print(
            '<p class="LC_error">'
           .&mt('Problems occurred in creating the new Excel file.')
           .' '.&mt('This error has been logged.')
           .' '.&mt('Please alert your LON-CAPA administrator.')
           .'</p>'
        );
        return (undef);
    }
    #
    $workbook->set_tempdir('/home/httpd/perl/tmp');
    #
    my $format = &Apache::loncommon::define_excel_formats($workbook);
    return ($workbook,$filename,$format);
}

###############################################################
###############################################################

=pod

=item * &create_text_file()

Create a file to write to and eventually make available to the user.
If file creation fails, outputs an error message on the request object and 
return undefs.

Inputs: Apache request object, and file suffix

Returns (undef) on failure, 
    Filehandle and filename on success.

=cut

###############################################################
###############################################################
sub create_text_file {
    my ($r,$suffix) = @_;
    if (! defined($suffix)) { $suffix = 'txt'; };
    my $fh;
    my $filename = '/prtspool/'.
        $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
        time.'_'.rand(1000000000).'.'.$suffix;
    $fh = Apache::File->new('>/home/httpd'.$filename);
    if (! defined($fh)) {
        $r->log_error("Couldn't open $filename for output $!");
        $r->print(
            '<p class="LC_error">'
           .&mt('Problems occurred in creating the output file.')
           .' '.&mt('This error has been logged.')
           .' '.&mt('Please alert your LON-CAPA administrator.')
           .'</p>'
        );
    }
    return ($fh,$filename)
}


=pod 

=back

=cut

###############################################################
##        Home server <option> list generating code          ##
###############################################################

# ------------------------------------------

sub domain_select {
    my ($name,$value,$multiple)=@_;
    my %domains=map { 
	$_ => $_.' '. &Apache::lonnet::domain($_,'description') 
    } &Apache::lonnet::all_domains();
    if ($multiple) {
	$domains{''}=&mt('Any domain');
	$domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
	return &multiple_select_form($name,$value,4,\%domains);
    } else {
	$domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
	return &select_form($name,$value,\%domains);
    }
}

#-------------------------------------------

=pod

=head1 Routines for form select boxes

=over 4

=item * &multiple_select_form($name,$value,$size,$hash,$order)

Returns a string containing a <select> element int multiple mode


Args:
  $name - name of the <select> element
  $value - scalar or array ref of values that should already be selected
  $size - number of rows long the select element is
  $hash - the elements should be 'option' => 'shown text'
          (shown text should already have been &mt())
  $order - (optional) array ref of the order to show the elements in

=cut

#-------------------------------------------
sub multiple_select_form {
    my ($name,$value,$size,$hash,$order)=@_;
    my %selected = map { $_ => 1 } ref($value)?@{$value}:($value);
    my $output='';
    if (! defined($size)) {
        $size = 4;
        if (scalar(keys(%$hash))<4) {
            $size = scalar(keys(%$hash));
        }
    }
    $output.="\n".'<select name="'.$name.'" size="'.$size.'" multiple="multiple">';
    my @order;
    if (ref($order) eq 'ARRAY')  {
        @order = @{$order};
    } else {
        @order = sort(keys(%$hash));
    }
    if (exists($$hash{'select_form_order'})) {
        @order = @{$$hash{'select_form_order'}};
    }
        
    foreach my $key (@order) {
        $output.='<option value="'.&HTML::Entities::encode($key,'"<>&').'" ';
        $output.='selected="selected" ' if ($selected{$key});
        $output.='>'.$hash->{$key}."</option>\n";
    }
    $output.="</select>\n";
    return $output;
}

#-------------------------------------------

=pod

=item * &select_form($defdom,$name,$hashref,$onchange)

Returns a string containing a <select name='$name' size='1'> form to 
allow a user to select options from a ref to a hash containing:
option_name => displayed text. An optional $onchange can include
a javascript onchange item, e.g., onchange="this.form.submit();"  

See lonrights.pm for an example invocation and use.

=cut

#-------------------------------------------
sub select_form {
    my ($def,$name,$hashref,$onchange) = @_;
    return unless (ref($hashref) eq 'HASH');
    if ($onchange) {
        $onchange = ' onchange="'.$onchange.'"';
    }
    my $selectform = "<select name=\"$name\" size=\"1\"$onchange>\n";
    my @keys;
    if (exists($hashref->{'select_form_order'})) {
	@keys=@{$hashref->{'select_form_order'}};
    } else {
	@keys=sort(keys(%{$hashref}));
    }
    foreach my $key (@keys) {
        $selectform.=
	    '<option value="'.&HTML::Entities::encode($key,'"<>&').'" '.
            ($key eq $def ? 'selected="selected" ' : '').
                ">".$hashref->{$key}."</option>\n";
    }
    $selectform.="</select>";
    return $selectform;
}

# For display filters

sub display_filter {
    if (!$env{'form.show'}) { $env{'form.show'}=10; }
    if (!$env{'form.displayfilter'}) { $env{'form.displayfilter'}='currentfolder'; }
    return '<span class="LC_nobreak"><label>'.&mt('Records [_1]',
			       &Apache::lonmeta::selectbox('show',$env{'form.show'},undef,
							   (&mt('all'),10,20,50,100,1000,10000))).
	   '</label></span> <span class="LC_nobreak">'.
           &mt('Filter [_1]',
	   &select_form($env{'form.displayfilter'},
			'displayfilter',
			{'currentfolder' => 'Current folder/page',
			 'containing' => 'Containing phrase',
			 'none' => 'None'})).
			 '<input type="text" name="containingphrase" size="30" value="'.&HTML::Entities::encode($env{'form.containingphrase'}).'" /></span>';
}

sub gradeleveldescription {
    my $gradelevel=shift;
    my %gradelevels=(0 => 'Not specified',
		     1 => 'Grade 1',
		     2 => 'Grade 2',
		     3 => 'Grade 3',
		     4 => 'Grade 4',
		     5 => 'Grade 5',
		     6 => 'Grade 6',
		     7 => 'Grade 7',
		     8 => 'Grade 8',
		     9 => 'Grade 9',
		     10 => 'Grade 10',
		     11 => 'Grade 11',
		     12 => 'Grade 12',
		     13 => 'Grade 13',
		     14 => '100 Level',
		     15 => '200 Level',
		     16 => '300 Level',
		     17 => '400 Level',
		     18 => 'Graduate Level');
    return &mt($gradelevels{$gradelevel});
}

sub select_level_form {
    my ($deflevel,$name)=@_;
    unless ($deflevel) { $deflevel=0; }
    my $selectform = "<select name=\"$name\" size=\"1\">\n";
    for (my $i=0; $i<=18; $i++) {
        $selectform.="<option value=\"$i\" ".
            ($i==$deflevel ? 'selected="selected" ' : '').
                ">".&gradeleveldescription($i)."</option>\n";
    }
    $selectform.="</select>";
    return $selectform;
}

#-------------------------------------------

=pod

=item * &select_dom_form($defdom,$name,$includeempty,$showdomdesc,$onchange,$incdoms)

Returns a string containing a <select name='$name' size='1'> form to 
allow a user to select the domain to preform an operation in.  
See loncreateuser.pm for an example invocation and use.

If the $includeempty flag is set, it also includes an empty choice ("no domain
selected");

If the $showdomdesc flag is set, the domain name is followed by the domain description.

The optional $onchange argument specifies what should occur if the domain selector is changed, e.g., 'this.form.submit()' if the form is to be automatically submitted.

The optional $incdoms is a reference to an array of domains which will be the only available options. 

=cut

#-------------------------------------------
sub select_dom_form {
    my ($defdom,$name,$includeempty,$showdomdesc,$onchange,$incdoms) = @_;
    if ($onchange) {
        $onchange = ' onchange="'.$onchange.'"';
    }
    my @domains;
    if (ref($incdoms) eq 'ARRAY') {
        @domains = sort {lc($a) cmp lc($b)} (@{$incdoms});
    } else {
        @domains = sort {lc($a) cmp lc($b)} (&Apache::lonnet::all_domains());
    }
    if ($includeempty) { @domains=('',@domains); }
    my $selectdomain = "<select name=\"$name\" size=\"1\"$onchange>\n";
    foreach my $dom (@domains) {
        $selectdomain.="<option value=\"$dom\" ".
            ($dom eq $defdom ? 'selected="selected" ' : '').'>'.$dom;
        if ($showdomdesc) {
            if ($dom ne '') {
                my $domdesc = &Apache::lonnet::domain($dom,'description');
                if ($domdesc ne '') {
                    $selectdomain .= ' ('.$domdesc.')';
                }
            } 
        }
        $selectdomain .= "</option>\n";
    }
    $selectdomain.="</select>";
    return $selectdomain;
}

#-------------------------------------------

=pod

=item * &home_server_form_item($domain,$name,$defaultflag)

input: 4 arguments (two required, two optional) - 
    $domain - domain of new user
    $name - name of form element
    $default - Value of 'default' causes a default item to be first 
                            option, and selected by default. 
    $hide - Value of 'hide' causes hiding of the name of the server, 
                            if 1 server found, or default, if 0 found.
output: returns 2 items: 
(a) form element which contains either:
   (i) <select name="$name">
        <option value="$hostid1">$hostid $servers{$hostid}</option>
        <option value="$hostid2">$hostid $servers{$hostid}</option>       
       </select>
       form item if there are multiple library servers in $domain, or
   (ii) an <input type="hidden" name="$name" value="$hostid" /> form item 
       if there is only one library server in $domain.

(b) number of library servers found.

See loncreateuser.pm for example of use.

=cut

#-------------------------------------------
sub home_server_form_item {
    my ($domain,$name,$default,$hide) = @_;
    my %servers = &Apache::lonnet::get_servers($domain,'library');
    my $result;
    my $numlib = keys(%servers);
    if ($numlib > 1) {
        $result .= '<select name="'.$name.'" />'."\n";
        if ($default) {
            $result .= '<option value="default" selected="selected">'.&mt('default').
                       '</option>'."\n";
        }
        foreach my $hostid (sort(keys(%servers))) {
            $result.= '<option value="'.$hostid.'">'.
	              $hostid.' '.$servers{$hostid}."</option>\n";
        }
        $result .= '</select>'."\n";
    } elsif ($numlib == 1) {
        my $hostid;
        foreach my $item (keys(%servers)) {
            $hostid = $item;
        }
        $result .= '<input type="hidden" name="'.$name.'" value="'.
                   $hostid.'" />';
                   if (!$hide) {
                       $result .= $hostid.' '.$servers{$hostid};
                   }
                   $result .= "\n";
    } elsif ($default) {
        $result .= '<input type="hidden" name="'.$name.
                   '" value="default" />';
                   if (!$hide) {
                       $result .= &mt('default');
                   }
                   $result .= "\n";
    }
    return ($result,$numlib);
}

=pod

=back 

=cut

###############################################################
##                  Decoding User Agent                      ##
###############################################################

=pod

=head1 Decoding the User Agent

=over 4

=item * &decode_user_agent()

Inputs: $r

Outputs:

=over 4

=item * $httpbrowser

=item * $clientbrowser

=item * $clientversion

=item * $clientmathml

=item * $clientunicode

=item * $clientos

=back

=back 

=cut

###############################################################
###############################################################
sub decode_user_agent {
    my ($r)=@_;
    my @browsertype=split(/\&/,$Apache::lonnet::perlvar{"lonBrowsDet"});
    my %mathcap=split(/\&/,$$Apache::lonnet::perlvar{"lonMathML"});
    my $httpbrowser=$ENV{"HTTP_USER_AGENT"};
    if (!$httpbrowser && $r) { $httpbrowser=$r->header_in('User-Agent'); }
    my $clientbrowser='unknown';
    my $clientversion='0';
    my $clientmathml='';
    my $clientunicode='0';
    for (my $i=0;$i<=$#browsertype;$i++) {
        my ($bname,$match,$notmatch,$vreg,$minv,$univ)=split(/\:/,$browsertype[$i]);
	if (($httpbrowser=~/$match/i)  && ($httpbrowser!~/$notmatch/i)) {
	    $clientbrowser=$bname;
            $httpbrowser=~/$vreg/i;
	    $clientversion=$1;
            $clientmathml=($clientversion>=$minv);
            $clientunicode=($clientversion>=$univ);
	}
    }
    my $clientos='unknown';
    if (($httpbrowser=~/linux/i) ||
        ($httpbrowser=~/unix/i) ||
        ($httpbrowser=~/ux/i) ||
        ($httpbrowser=~/solaris/i)) { $clientos='unix'; }
    if (($httpbrowser=~/vax/i) ||
        ($httpbrowser=~/vms/i)) { $clientos='vms'; }
    if ($httpbrowser=~/next/i) { $clientos='next'; }
    if (($httpbrowser=~/mac/i) ||
        ($httpbrowser=~/powerpc/i)) { $clientos='mac'; }
    if ($httpbrowser=~/win/i) { $clientos='win'; }
    if ($httpbrowser=~/embed/i) { $clientos='pda'; }
    return ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
            $clientunicode,$clientos,);
}

###############################################################
##    Authentication changing form generation subroutines    ##
###############################################################
##
## All of the authform_xxxxxxx subroutines take their inputs in a
## hash, and have reasonable default values.
##
##    formname = the name given in the <form> tag.
#-------------------------------------------

=pod

=head1 Authentication Routines

=over 4

=item * &authform_xxxxxx()

The authform_xxxxxx subroutines provide javascript and html forms which 
handle some of the conveniences required for authentication forms.  
This is not an optimal method, but it works.  

=over 4

=item * authform_header

=item * authform_authorwarning

=item * authform_nochange

=item * authform_kerberos

=item * authform_internal

=item * authform_filesystem

=back

See loncreateuser.pm for invocation and use examples.

=cut

#-------------------------------------------
sub authform_header{  
    my %in = (
        formname => 'cu',
        kerb_def_dom => '',
        @_,
    );
    $in{'formname'} = 'document.' . $in{'formname'};
    my $result='';

#---------------------------------------------- Code for upper case translation
    my $Javascript_toUpperCase;
    unless ($in{kerb_def_dom}) {
        $Javascript_toUpperCase =<<"END";
        switch (choice) {
           case 'krb': currentform.elements[choicearg].value =
               currentform.elements[choicearg].value.toUpperCase();
               break;
           default:
        }
END
    } else {
        $Javascript_toUpperCase = "";
    }

    my $radioval = "'nochange'";
    if (defined($in{'curr_authtype'})) {
        if ($in{'curr_authtype'} ne '') {
            $radioval = "'".$in{'curr_authtype'}."arg'";
        }
    }
    my $argfield = 'null';
    if (defined($in{'mode'})) {
        if ($in{'mode'} eq 'modifycourse')  {
            if (defined($in{'curr_autharg'})) {
                if ($in{'curr_autharg'} ne '') {
                    $argfield = "'$in{'curr_autharg'}'";
                }
            }
        }
    }

    $result.=<<"END";
var current = new Object();
current.radiovalue = $radioval;
current.argfield = $argfield;

function changed_radio(choice,currentform) {
    var choicearg = choice + 'arg';
    // If a radio button in changed, we need to change the argfield
    if (current.radiovalue != choice) {
        current.radiovalue = choice;
        if (current.argfield != null) {
            currentform.elements[current.argfield].value = '';
        }
        if (choice == 'nochange') {
            current.argfield = null;
        } else {
            current.argfield = choicearg;
            switch(choice) {
                case 'krb': 
                    currentform.elements[current.argfield].value = 
                        "$in{'kerb_def_dom'}";
                break;
              default:
                break;
            }
        }
    }
    return;
}

function changed_text(choice,currentform) {
    var choicearg = choice + 'arg';
    if (currentform.elements[choicearg].value !='') {
        $Javascript_toUpperCase
        // clear old field
        if ((current.argfield != choicearg) && (current.argfield != null)) {
            currentform.elements[current.argfield].value = '';
        }
        current.argfield = choicearg;
    }
    set_auth_radio_buttons(choice,currentform);
    return;
}

function set_auth_radio_buttons(newvalue,currentform) {
    var numauthchoices = currentform.login.length;
    if (typeof numauthchoices  == "undefined") {
        return;
    } 
    var i=0;
    while (i < numauthchoices) {
        if (currentform.login[i].value == newvalue) { break; }
        i++;
    }
    if (i == numauthchoices) {
        return;
    }
    current.radiovalue = newvalue;
    currentform.login[i].checked = true;
    return;
}
END
    return $result;
}

sub authform_authorwarning{
    my $result='';
    $result='<i>'.
        &mt('As a general rule, only authors or co-authors should be '.
            'filesystem authenticated '.
            '(which allows access to the server filesystem).')."</i>\n";
    return $result;
}

sub authform_nochange{  
    my %in = (
              formname => 'document.cu',
              kerb_def_dom => 'MSU.EDU',
              @_,
          );
    my ($authnum,%can_assign) =  &get_assignable_auth($in{'domain'}); 
    my $result;
    if (keys(%can_assign) == 0) {
        $result = &mt('Under you current role you are not permitted to change login settings for this user');  
    } else {
        $result = '<label>'.&mt('[_1] Do not change login data',
                  '<input type="radio" name="login" value="nochange" '.
                  'checked="checked" onclick="'.
            "javascript:changed_radio('nochange',$in{'formname'});".'" />').
	    '</label>';
    }
    return $result;
}

sub authform_kerberos {
    my %in = (
              formname => 'document.cu',
              kerb_def_dom => 'MSU.EDU',
              kerb_def_auth => 'krb4',
              @_,
              );
    my ($check4,$check5,$krbcheck,$krbarg,$krbver,$result,$authtype,
        $autharg,$jscall);
    my ($authnum,%can_assign) =  &get_assignable_auth($in{'domain'});
    if ($in{'kerb_def_auth'} eq 'krb5') {
       $check5 = ' checked="checked"';
    } else {
       $check4 = ' checked="checked"';
    }
    $krbarg = $in{'kerb_def_dom'};
    if (defined($in{'curr_authtype'})) {
        if ($in{'curr_authtype'} eq 'krb') {
            $krbcheck = ' checked="checked"';
            if (defined($in{'mode'})) {
                if ($in{'mode'} eq 'modifyuser') {
                    $krbcheck = '';
                }
            }
            if (defined($in{'curr_kerb_ver'})) {
                if ($in{'curr_krb_ver'} eq '5') {
                    $check5 = ' checked="checked"';
                    $check4 = '';
                } else {
                    $check4 = ' checked="checked"';
                    $check5 = '';
                }
            }
            if (defined($in{'curr_autharg'})) {
                $krbarg = $in{'curr_autharg'};
            }
            if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
                if (defined($in{'curr_autharg'})) {
                    $result = 
    &mt('Currently Kerberos authenticated with domain [_1] Version [_2].',
        $in{'curr_autharg'},$krbver);
                } else {
                    $result =
    &mt('Currently Kerberos authenticated, Version [_1].',$krbver);
                }
                return $result; 
            }
        }
    } else {
        if ($authnum == 1) {
            $authtype = '<input type="hidden" name="login" value="krb" />';
        }
    }
    if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
        return;
    } elsif ($authtype eq '') {
        if (defined($in{'mode'})) {
            if ($in{'mode'} eq 'modifycourse') {
                if ($authnum == 1) {
                    $authtype = '<input type="hidden" name="login" value="krb" />';
                }
            }
        }
    }
    $jscall = "javascript:changed_radio('krb',$in{'formname'});";
    if ($authtype eq '') {
        $authtype = '<input type="radio" name="login" value="krb" '.
                    'onclick="'.$jscall.'" onchange="'.$jscall.'"'.
                    $krbcheck.' />';
    }
    if (($can_assign{'krb4'} && $can_assign{'krb5'}) ||
        ($can_assign{'krb4'} && !$can_assign{'krb5'} && 
         $in{'curr_authtype'} eq 'krb5') ||
        (!$can_assign{'krb4'} && $can_assign{'krb5'} && 
         $in{'curr_authtype'} eq 'krb4')) {
        $result .= &mt
        ('[_1] Kerberos authenticated with domain [_2] '.
         '[_3] Version 4 [_4] Version 5 [_5]',
         '<label>'.$authtype,
         '</label><input type="text" size="10" name="krbarg" '.
             'value="'.$krbarg.'" '.
             'onchange="'.$jscall.'" />',
         '<label><input type="radio" name="krbver" value="4" '.$check4.' />',
         '</label><label><input type="radio" name="krbver" value="5" '.$check5.' />',
	 '</label>');
    } elsif ($can_assign{'krb4'}) {
        $result .= &mt
        ('[_1] Kerberos authenticated with domain [_2] '.
         '[_3] Version 4 [_4]',
         '<label>'.$authtype,
         '</label><input type="text" size="10" name="krbarg" '.
             'value="'.$krbarg.'" '.
             'onchange="'.$jscall.'" />',
         '<label><input type="hidden" name="krbver" value="4" />',
         '</label>');
    } elsif ($can_assign{'krb5'}) {
        $result .= &mt
        ('[_1] Kerberos authenticated with domain [_2] '.
         '[_3] Version 5 [_4]',
         '<label>'.$authtype,
         '</label><input type="text" size="10" name="krbarg" '.
             'value="'.$krbarg.'" '.
             'onchange="'.$jscall.'" />',
         '<label><input type="hidden" name="krbver" value="5" />',
         '</label>');
    }
    return $result;
}

sub authform_internal{  
    my %in = (
                formname => 'document.cu',
                kerb_def_dom => 'MSU.EDU',
                @_,
                );
    my ($intcheck,$intarg,$result,$authtype,$autharg,$jscall);
    my ($authnum,%can_assign) =  &get_assignable_auth($in{'domain'});
    if (defined($in{'curr_authtype'})) {
        if ($in{'curr_authtype'} eq 'int') {
            if ($can_assign{'int'}) {
                $intcheck = 'checked="checked" ';
                if (defined($in{'mode'})) {
                    if ($in{'mode'} eq 'modifyuser') {
                        $intcheck = '';
                    }
                }
                if (defined($in{'curr_autharg'})) {
                    $intarg = $in{'curr_autharg'};
                }
            } else {
                $result = &mt('Currently internally authenticated.');
                return $result;
            }
        }
    } else {
        if ($authnum == 1) {
            $authtype = '<input type="hidden" name="login" value="int" />';
        }
    }
    if (!$can_assign{'int'}) {
        return;
    } elsif ($authtype eq '') {
        if (defined($in{'mode'})) {
            if ($in{'mode'} eq 'modifycourse') {
                if ($authnum == 1) {
                    $authtype = '<input type="hidden" name="login" value="int" />';
                }
            }
        }
    }
    $jscall = "javascript:changed_radio('int',$in{'formname'});";
    if ($authtype eq '') {
        $authtype = '<input type="radio" name="login" value="int" '.$intcheck.
                    ' onchange="'.$jscall.'" onclick="'.$jscall.'" />';
    }
    $autharg = '<input type="password" size="10" name="intarg" value="'.
               $intarg.'" onchange="'.$jscall.'" />';
    $result = &mt
        ('[_1] Internally authenticated (with initial password [_2])',
         '<label>'.$authtype,'</label>'.$autharg);
    $result.="<label><input type=\"checkbox\" name=\"visible\" onclick='if (this.checked) { this.form.intarg.type=\"text\" } else { this.form.intarg.type=\"password\" }' />".&mt('Visible input').'</label>';
    return $result;
}

sub authform_local{  
    my %in = (
              formname => 'document.cu',
              kerb_def_dom => 'MSU.EDU',
              @_,
              );
    my ($loccheck,$locarg,$result,$authtype,$autharg,$jscall);
    my ($authnum,%can_assign) =  &get_assignable_auth($in{'domain'});
    if (defined($in{'curr_authtype'})) {
        if ($in{'curr_authtype'} eq 'loc') {
            if ($can_assign{'loc'}) {
                $loccheck = 'checked="checked" ';
                if (defined($in{'mode'})) {
                    if ($in{'mode'} eq 'modifyuser') {
                        $loccheck = '';
                    }
                }
                if (defined($in{'curr_autharg'})) {
                    $locarg = $in{'curr_autharg'};
                }
            } else {
                $result = &mt('Currently using local (institutional) authentication.');
                return $result;
            }
        }
    } else {
        if ($authnum == 1) {
            $authtype = '<input type="hidden" name="login" value="loc" />';
        }
    }
    if (!$can_assign{'loc'}) {
        return;
    } elsif ($authtype eq '') {
        if (defined($in{'mode'})) {
            if ($in{'mode'} eq 'modifycourse') {
                if ($authnum == 1) {
                    $authtype = '<input type="hidden" name="login" value="loc" />';
                }
            }
        }
    }
    $jscall = "javascript:changed_radio('loc',$in{'formname'});";
    if ($authtype eq '') {
        $authtype = '<input type="radio" name="login" value="loc" '.
                    $loccheck.' onchange="'.$jscall.'" onclick="'.
                    $jscall.'" />';
    }
    $autharg = '<input type="text" size="10" name="locarg" value="'.
               $locarg.'" onchange="'.$jscall.'" />';
    $result = &mt('[_1] Local Authentication with argument [_2]',
                  '<label>'.$authtype,'</label>'.$autharg);
    return $result;
}

sub authform_filesystem{  
    my %in = (
              formname => 'document.cu',
              kerb_def_dom => 'MSU.EDU',
              @_,
              );
    my ($fsyscheck,$result,$authtype,$autharg,$jscall);
    my ($authnum,%can_assign) =  &get_assignable_auth($in{'domain'});
    if (defined($in{'curr_authtype'})) {
        if ($in{'curr_authtype'} eq 'fsys') {
            if ($can_assign{'fsys'}) {
                $fsyscheck = 'checked="checked" ';
                if (defined($in{'mode'})) {
                    if ($in{'mode'} eq 'modifyuser') {
                        $fsyscheck = '';
                    }
                }
            } else {
                $result = &mt('Currently Filesystem Authenticated.');
                return $result;
            }           
        }
    } else {
        if ($authnum == 1) {
            $authtype = '<input type="hidden" name="login" value="fsys" />';
        }
    }
    if (!$can_assign{'fsys'}) {
        return;
    } elsif ($authtype eq '') {
        if (defined($in{'mode'})) {
            if ($in{'mode'} eq 'modifycourse') {
                if ($authnum == 1) {
                    $authtype = '<input type="hidden" name="login" value="fsys" />';
                }
            }
        }
    }
    $jscall = "javascript:changed_radio('fsys',$in{'formname'});";
    if ($authtype eq '') {
        $authtype = '<input type="radio" name="login" value="fsys" '.
                    $fsyscheck.' onchange="'.$jscall.'" onclick="'.
                    $jscall.'" />';
    }
    $autharg = '<input type="text" size="10" name="fsysarg" value=""'.
               ' onchange="'.$jscall.'" />';
    $result = &mt
        ('[_1] Filesystem Authenticated (with initial password [_2])',
         '<label><input type="radio" name="login" value="fsys" '.
         $fsyscheck.'onchange="'.$jscall.'" onclick="'.$jscall.'" />',
         '</label><input type="password" size="10" name="fsysarg" value="" '.
                  'onchange="'.$jscall.'" />');
    return $result;
}

sub get_assignable_auth {
    my ($dom) = @_;
    if ($dom eq '') {
        $dom = $env{'request.role.domain'};
    }
    my %can_assign = (
                          krb4 => 1,
                          krb5 => 1,
                          int  => 1,
                          loc  => 1,
                     );
    my %domconfig = &Apache::lonnet::get_dom('configuration',['usercreation'],$dom);
    if (ref($domconfig{'usercreation'}) eq 'HASH') {
        if (ref($domconfig{'usercreation'}{'authtypes'}) eq 'HASH') {
            my $authhash = $domconfig{'usercreation'}{'authtypes'};
            my $context;
            if ($env{'request.role'} =~ /^au/) {
                $context = 'author';
            } elsif ($env{'request.role'} =~ /^dc/) {
                $context = 'domain';
            } elsif ($env{'request.course.id'}) {
                $context = 'course';
            }
            if ($context) {
                if (ref($authhash->{$context}) eq 'HASH') {
                   %can_assign = %{$authhash->{$context}}; 
                }
            }
        }
    }
    my $authnum = 0;
    foreach my $key (keys(%can_assign)) {
        if ($can_assign{$key}) {
            $authnum ++;
        }
    }
    if ($can_assign{'krb4'} && $can_assign{'krb5'}) {
        $authnum --;
    }
    return ($authnum,%can_assign);
}

###############################################################
##    Get Kerberos Defaults for Domain                 ##
###############################################################
##
## Returns default kerberos version and an associated argument
## as listed in file domain.tab. If not listed, provides
## appropriate default domain and kerberos version.
##
#-------------------------------------------

=pod

=item * &get_kerberos_defaults()

get_kerberos_defaults($target_domain) returns the default kerberos
version and domain. If not found, it defaults to version 4 and the 
domain of the server.

=over 4

($def_version, $def_krb_domain) = &get_kerberos_defaults($target_domain);

=back

=back

=cut

#-------------------------------------------
sub get_kerberos_defaults {
    my $domain=shift;
    my ($krbdef,$krbdefdom);
    my %domdefaults = &Apache::lonnet::get_domain_defaults($domain);
    if (($domdefaults{'auth_def'} =~/^krb(4|5)$/) && ($domdefaults{'auth_arg_def'} ne '')) {
        $krbdef = $domdefaults{'auth_def'};
        $krbdefdom = $domdefaults{'auth_arg_def'};
    } else {
        $ENV{'SERVER_NAME'}=~/(\w+\.\w+)$/;
        my $krbdefdom=$1;
        $krbdefdom=~tr/a-z/A-Z/;
        $krbdef = "krb4";
    }
    return ($krbdef,$krbdefdom);
}


###############################################################
##                Thesaurus Functions                        ##
###############################################################

=pod

=head1 Thesaurus Functions

=over 4

=item * &initialize_keywords()

Initializes the package variable %Keywords if it is empty.  Uses the
package variable $thesaurus_db_file.

=cut

###################################################

sub initialize_keywords {
    return 1 if (scalar keys(%Keywords));
    # If we are here, %Keywords is empty, so fill it up
    #   Make sure the file we need exists...
    if (! -e $thesaurus_db_file) {
        &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file".
                                 " failed because it does not exist");
        return 0;
    }
    #   Set up the hash as a database
    my %thesaurus_db;
    if (! tie(%thesaurus_db,'GDBM_File',
              $thesaurus_db_file,&GDBM_READER(),0640)){
        &Apache::lonnet::logthis("Could not tie \%thesaurus_db to ".
                                 $thesaurus_db_file);
        return 0;
    } 
    #  Get the average number of appearances of a word.
    my $avecount = $thesaurus_db{'average.count'};
    #  Put keywords (those that appear > average) into %Keywords
    while (my ($word,$data)=each (%thesaurus_db)) {
        my ($count,undef) = split /:/,$data;
        $Keywords{$word}++ if ($count > $avecount);
    }
    untie %thesaurus_db;
    # Remove special values from %Keywords.
    foreach my $value ('total.count','average.count') {
        delete($Keywords{$value}) if (exists($Keywords{$value}));
  }
    return 1;
}

###################################################

=pod

=item * &keyword($word)

Returns true if $word is a keyword.  A keyword is a word that appears more 
than the average number of times in the thesaurus database.  Calls 
&initialize_keywords

=cut

###################################################

sub keyword {
    return if (!&initialize_keywords());
    my $word=lc(shift());
    $word=~s/\W//g;
    return exists($Keywords{$word});
}

###############################################################

=pod 

=item * &get_related_words()

Look up a word in the thesaurus.  Takes a scalar argument and returns
an array of words.  If the keyword is not in the thesaurus, an empty array
will be returned.  The order of the words returned is determined by the
database which holds them.

Uses global $thesaurus_db_file.

=cut

###############################################################
sub get_related_words {
    my $keyword = shift;
    my %thesaurus_db;
    if (! -e $thesaurus_db_file) {
        &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file ".
                                 "failed because the file does not exist");
        return ();
    }
    if (! tie(%thesaurus_db,'GDBM_File',
              $thesaurus_db_file,&GDBM_READER(),0640)){
        return ();
    } 
    my @Words=();
    my $count=0;
    if (exists($thesaurus_db{$keyword})) {
	# The first element is the number of times
	# the word appears.  We do not need it now.
	my (undef,@RelatedWords) = (split(/:/,$thesaurus_db{$keyword}));
	my (undef,$mostfrequentcount)=split(/\,/,$RelatedWords[0]);
	my $threshold=$mostfrequentcount/10;
        foreach my $possibleword (@RelatedWords) {
            my ($word,$wordcount)=split(/\,/,$possibleword);
            if ($wordcount>$threshold) {
		push(@Words,$word);
                $count++;
                if ($count>10) { last; }
	    }
        }
    }
    untie %thesaurus_db;
    return @Words;
}

=pod

=back

=cut

# -------------------------------------------------------------- Plaintext name
=pod

=head1 User Name Functions

=over 4

=item * &plainname($uname,$udom,$first)

Takes a users logon name and returns it as a string in
"first middle last generation" form 
if $first is set to 'lastname' then it returns it as
'lastname generation, firstname middlename' if their is a lastname

=cut


###############################################################
sub plainname {
    my ($uname,$udom,$first)=@_;
    return if (!defined($uname) || !defined($udom));
    my %names=&getnames($uname,$udom);
    my $name=&Apache::lonnet::format_name($names{'firstname'},
					  $names{'middlename'},
					  $names{'lastname'},
					  $names{'generation'},$first);
    $name=~s/^\s+//;
    $name=~s/\s+$//;
    $name=~s/\s+/ /g;
    if ($name !~ /\S/) { $name=$uname.':'.$udom; }
    return $name;
}

# -------------------------------------------------------------------- Nickname
=pod

=item * &nickname($uname,$udom)

Gets a users name and returns it as a string as

"&quot;nickname&quot;"

if the user has a nickname or

"first middle last generation"

if the user does not

=cut

sub nickname {
    my ($uname,$udom)=@_;
    return if (!defined($uname) || !defined($udom));
    my %names=&getnames($uname,$udom);
    my $name=$names{'nickname'};
    if ($name) {
       $name='&quot;'.$name.'&quot;'; 
    } else {
       $name=$names{'firstname'}.' '.$names{'middlename'}.' '.
	     $names{'lastname'}.' '.$names{'generation'};
       $name=~s/\s+$//;
       $name=~s/\s+/ /g;
    }
    return $name;
}

sub getnames {
    my ($uname,$udom)=@_;
    return if (!defined($uname) || !defined($udom));
    if ($udom eq 'public' && $uname eq 'public') {
	return ('lastname' => &mt('Public'));
    }
    my $id=$uname.':'.$udom;
    my ($names,$cached)=&Apache::lonnet::is_cached_new('namescache',$id);
    if ($cached) {
	return %{$names};
    } else {
	my %loadnames=&Apache::lonnet::get('environment',
                    ['firstname','middlename','lastname','generation','nickname'],
					 $udom,$uname);
	&Apache::lonnet::do_cache_new('namescache',$id,\%loadnames);
	return %loadnames;
    }
}

# -------------------------------------------------------------------- getemails

=pod

=item * &getemails($uname,$udom)

Gets a user's email information and returns it as a hash with keys:
notification, critnotification, permanentemail

For notification and critnotification, values are comma-separated lists 
of e-mail addresses; for permanentemail, value is a single e-mail address.
 

=cut


sub getemails {
    my ($uname,$udom)=@_;
    if ($udom eq 'public' && $uname eq 'public') {
	return;
    }
    if (!$udom) { $udom=$env{'user.domain'}; }
    if (!$uname) { $uname=$env{'user.name'}; }
    my $id=$uname.':'.$udom;
    my ($names,$cached)=&Apache::lonnet::is_cached_new('emailscache',$id);
    if ($cached) {
	return %{$names};
    } else {
	my %loadnames=&Apache::lonnet::get('environment',
                    			   ['notification','critnotification',
					    'permanentemail'],
					   $udom,$uname);
	&Apache::lonnet::do_cache_new('emailscache',$id,\%loadnames);
	return %loadnames;
    }
}

sub flush_email_cache {
    my ($uname,$udom)=@_;
    if (!$udom)  { $udom =$env{'user.domain'}; }
    if (!$uname) { $uname=$env{'user.name'};   }
    return if ($udom eq 'public' && $uname eq 'public');
    my $id=$uname.':'.$udom;
    &Apache::lonnet::devalidate_cache_new('emailscache',$id);
}

# -------------------------------------------------------------------- getlangs

=pod

=item * &getlangs($uname,$udom)

Gets a user's language preference and returns it as a hash with key:
language.

=cut


sub getlangs {
    my ($uname,$udom) = @_;
    if (!$udom)  { $udom =$env{'user.domain'}; }
    if (!$uname) { $uname=$env{'user.name'};   }
    my $id=$uname.':'.$udom;
    my ($langs,$cached)=&Apache::lonnet::is_cached_new('userlangs',$id);
    if ($cached) {
        return %{$langs};
    } else {
        my %loadlangs=&Apache::lonnet::get('environment',['languages'],
                                           $udom,$uname);
        &Apache::lonnet::do_cache_new('userlangs',$id,\%loadlangs);
        return %loadlangs;
    }
}

sub flush_langs_cache {
    my ($uname,$udom)=@_;
    if (!$udom)  { $udom =$env{'user.domain'}; }
    if (!$uname) { $uname=$env{'user.name'};   }
    return if ($udom eq 'public' && $uname eq 'public');
    my $id=$uname.':'.$udom;
    &Apache::lonnet::devalidate_cache_new('userlangs',$id);
}

# ------------------------------------------------------------------ Screenname

=pod

=item * &screenname($uname,$udom)

Gets a users screenname and returns it as a string

=cut

sub screenname {
    my ($uname,$udom)=@_;
    if ($uname eq $env{'user.name'} &&
	$udom eq $env{'user.domain'}) {return $env{'environment.screenname'};}
    my %names=&Apache::lonnet::get('environment',['screenname'],$udom,$uname);
    return $names{'screenname'};
}


# ------------------------------------------------------------- Confirm Wrapper
=pod

=item confirmwrapper

Wrap messages about completion of operation in box

=cut

sub confirmwrapper {
    my ($message)=@_;
    if ($message) {
        return "\n".'<div class="LC_confirm_box">'."\n"
               .$message."\n"
               .'</div>'."\n";
    } else {
        return $message;
    }
}

# ------------------------------------------------------------- Message Wrapper

sub messagewrapper {
    my ($link,$username,$domain,$subject,$text)=@_;
    return 
        '<a href="/adm/email?compose=individual&amp;'.
        'recname='.$username.'&amp;recdom='.$domain.
	'&amp;subject='.&escape($subject).'&amp;text='.&escape($text).'" '.
        'title="'.&mt('Send message').'">'.$link.'</a>';
}

# --------------------------------------------------------------- Notes Wrapper

sub noteswrapper {
    my ($link,$un,$do)=@_;
    return 
"<a href='/adm/email?recordftf=retrieve&amp;recname=$un&amp;recdom=$do'>$link</a>";
}

# ------------------------------------------------------------- Aboutme Wrapper

sub aboutmewrapper {
    my ($link,$username,$domain,$target)=@_;
    if (!defined($username)  && !defined($domain)) {
        return;
    }
    return '<a href="/adm/'.$domain.'/'.$username.'/aboutme?forcestudent=1"'.
	($target?' target="$target"':'').' title="'.&mt("View this user's personal information page").'">'.$link.'</a>';
}

# ------------------------------------------------------------ Syllabus Wrapper

sub syllabuswrapper {
    my ($linktext,$coursedir,$domain)=@_;
    return qq{<a href="/public/$domain/$coursedir/syllabus">$linktext</a>};
}

# -----------------------------------------------------------------------------

sub track_student_link {
    my ($linktext,$sname,$sdom,$target,$start,$only_body) = @_;
    my $link ="/adm/trackstudent?";
    my $title = 'View recent activity';
    if (defined($sname) && $sname !~ /^\s*$/ &&
        defined($sdom)  && $sdom  !~ /^\s*$/) {
        $link .= "selected_student=$sname:$sdom";
        $title .= ' of this student';
    } 
    if (defined($target) && $target !~ /^\s*$/) {
        $target = qq{target="$target"};
    } else {
        $target = '';
    }
    if ($start) { $link.='&amp;start='.$start; }
    if ($only_body) { $link .= '&amp;only_body=1'; }
    $title = &mt($title);
    $linktext = &mt($linktext);
    return qq{<a href="$link" title="$title" $target>$linktext</a>}.
	&help_open_topic('View_recent_activity');
}

sub slot_reservations_link {
    my ($linktext,$sname,$sdom,$target) = @_;
    my $link ="/adm/slotrequest?command=showresv&amp;origin=aboutme";
    my $title = 'View slot reservation history';
    if (defined($sname) && $sname !~ /^\s*$/ &&
        defined($sdom)  && $sdom  !~ /^\s*$/) {
        $link .= "&amp;uname=$sname&amp;udom=$sdom";
        $title .= ' of this student';
    }
    if (defined($target) && $target !~ /^\s*$/) {
        $target = qq{target="$target"};
    } else {
        $target = '';
    }
    $title = &mt($title);
    $linktext = &mt($linktext);
    return qq{<a href="$link" title="$title" $target>$linktext</a>};
# FIXME uncomment when help item created: &help_open_topic('Slot_Reservation_History');

}

# ===================================================== Display a student photo


sub student_image_tag {
    my ($domain,$user)=@_;
    my $imgsrc=&Apache::lonnet::studentphoto($domain,$user,'jpg');
    if (($imgsrc) && ($imgsrc ne '/adm/lonKaputt/lonlogo_broken.gif')) {
	return '<img src="'.$imgsrc.'" align="right" />';
    } else {
	return '';
    }
}

=pod

=back

=head1 Access .tab File Data

=over 4

=item * &languageids() 

returns list of all language ids

=cut

sub languageids {
    return sort(keys(%language));
}

=pod

=item * &languagedescription() 

returns description of a specified language id

=cut

sub languagedescription {
    my $code=shift;
    return  ($supported_language{$code}?'* ':'').
            $language{$code}.
	    ($supported_language{$code}?' ('.&mt('interface available').')':'');
}

sub plainlanguagedescription {
    my $code=shift;
    return $language{$code};
}

sub supportedlanguagecode {
    my $code=shift;
    return $supported_language{$code};
}

=pod

=item * &copyrightids() 

returns list of all copyrights

=cut

sub copyrightids {
    return sort(keys(%cprtag));
}

=pod

=item * &copyrightdescription() 

returns description of a specified copyright id

=cut

sub copyrightdescription {
    return &mt($cprtag{shift(@_)});
}

=pod

=item * &source_copyrightids() 

returns list of all source copyrights

=cut

sub source_copyrightids {
    return sort(keys(%scprtag));
}

=pod

=item * &source_copyrightdescription() 

returns description of a specified source copyright id

=cut

sub source_copyrightdescription {
    return &mt($scprtag{shift(@_)});
}

=pod

=item * &filecategories() 

returns list of all file categories

=cut

sub filecategories {
    return sort(keys(%category_extensions));
}

=pod

=item * &filecategorytypes() 

returns list of file types belonging to a given file
category

=cut

sub filecategorytypes {
    my ($cat) = @_;
    return @{$category_extensions{lc($cat)}};
}

=pod

=item * &fileembstyle() 

returns embedding style for a specified file type

=cut

sub fileembstyle {
    return $fe{lc(shift(@_))};
}

sub filemimetype {
    return $fm{lc(shift(@_))};
}


sub filecategoryselect {
    my ($name,$value)=@_;
    return &select_form($value,$name,
                        {'' => &mt('Any category'), map { $_,$_ } sort(keys(%category_extensions))});
}

=pod

=item * &filedescription() 

returns description for a specified file type

=cut

sub filedescription {
    my $file_description = $fd{lc(shift())};
    $file_description =~ s:([\[\]]):~$1:g;
    return &mt($file_description);
}

=pod

=item * &filedescriptionex() 

returns description for a specified file type with
extra formatting

=cut

sub filedescriptionex {
    my $ex=shift;
    my $file_description = $fd{lc($ex)};
    $file_description =~ s:([\[\]]):~$1:g;
    return '.'.$ex.' '.&mt($file_description);
}

# End of .tab access
=pod

=back

=cut

# ------------------------------------------------------------------ File Types
sub fileextensions {
    return sort(keys(%fe));
}

# ----------------------------------------------------------- Display Languages
# returns a hash with all desired display languages
#

sub display_languages {
    my %languages=();
    foreach my $lang (&Apache::lonlocal::preferred_languages()) {
	$languages{$lang}=1;
    }
    &get_unprocessed_cgi($ENV{'QUERY_STRING'},['displaylanguage']);
    if ($env{'form.displaylanguage'}) {
	foreach my $lang (split(/\s*(\,|\;|\:)\s*/,$env{'form.displaylanguage'})) {
	    $languages{$lang}=1;
        }
    }
    return %languages;
}

sub languages {
    my ($possible_langs) = @_;
    my @preferred_langs = &Apache::lonlocal::preferred_languages();
    if (!ref($possible_langs)) {
	if( wantarray ) {
	    return @preferred_langs;
	} else {
	    return $preferred_langs[0];
	}
    }
    my %possibilities = map { $_ => 1 } (@$possible_langs);
    my @preferred_possibilities;
    foreach my $preferred_lang (@preferred_langs) {
	if (exists($possibilities{$preferred_lang})) {
	    push(@preferred_possibilities, $preferred_lang);
	}
    }
    if( wantarray ) {
	return @preferred_possibilities;
    }
    return $preferred_possibilities[0];
}

sub user_lang {
    my ($touname,$toudom,$fromcid) = @_;
    my @userlangs;
    if (($fromcid ne '') && ($env{'course.'.$fromcid.'.languages'} ne '')) {
        @userlangs=(@userlangs,split(/\s*(\,|\;|\:)\s*/,
                    $env{'course.'.$fromcid.'.languages'}));
    } else {
        my %langhash = &getlangs($touname,$toudom);
        if ($langhash{'languages'} ne '') {
            @userlangs = split(/\s*(\,|\;|\:)\s*/,$langhash{'languages'});
        } else {
            my %domdefs = &Apache::lonnet::get_domain_defaults($toudom);
            if ($domdefs{'lang_def'} ne '') {
                @userlangs = ($domdefs{'lang_def'});
            }
        }
    }
    my @languages=&Apache::lonlocal::get_genlanguages(@userlangs);
    my $user_lh = Apache::localize->get_handle(@languages);
    return $user_lh;
}


###############################################################
##               Student Answer Attempts                     ##
###############################################################

=pod

=head1 Alternate Problem Views

=over 4

=item * &get_previous_attempt($symb, $username, $domain, $course,
    $getattempt, $regexp, $gradesub)

Return string with previous attempt on problem. Arguments:

=over 4

=item * $symb: Problem, including path

=item * $username: username of the desired student

=item * $domain: domain of the desired student

=item * $course: Course ID

=item * $getattempt: Leave blank for all attempts, otherwise put
    something

=item * $regexp: if string matches this regexp, the string will be
    sent to $gradesub

=item * $gradesub: routine that processes the string if it matches $regexp

=back

The output string is a table containing all desired attempts, if any.

=cut

sub get_previous_attempt {
  my ($symb,$username,$domain,$course,$getattempt,$regexp,$gradesub)=@_;
  my $prevattempts='';
  no strict 'refs';
  if ($symb) {
    my (%returnhash)=
      &Apache::lonnet::restore($symb,$course,$domain,$username);
    if ($returnhash{'version'}) {
      my %lasthash=();
      my $version;
      for ($version=1;$version<=$returnhash{'version'};$version++) {
        foreach my $key (sort(split(/\:/,$returnhash{$version.':keys'}))) {
	  $lasthash{$key}=$returnhash{$version.':'.$key};
        }
      }
      $prevattempts=&start_data_table().&start_data_table_header_row();
      $prevattempts.='<th>'.&mt('History').'</th>';
      my (%typeparts,%lasthidden);
      my $showsurv=&Apache::lonnet::allowed('vas',$env{'request.course.id'});
      foreach my $key (sort(keys(%lasthash))) {
	my ($ign,@parts) = split(/\./,$key);
	if ($#parts > 0) {
	  my $data=$parts[-1];
	  pop(@parts);
          if ($data eq 'type') {
              unless ($showsurv) {
                  my $id = join(',',@parts);
                  $typeparts{$ign.'.'.$id} = $lasthash{$key};
                  if (($lasthash{$key} eq 'anonsurvey') || ($lasthash{$key} eq 'anonsurveycred')) {
                      $lasthidden{$ign.'.'.$id} = 1;
                  }
              }
              delete($lasthash{$key});
          } else {
	      $prevattempts.='<th>'.&mt('Part ').join('.',@parts).'<br />'.$data.'&nbsp;</th>';
          }
	} else {
	  if ($#parts == 0) {
	    $prevattempts.='<th>'.$parts[0].'</th>';
	  } else {
	    $prevattempts.='<th>'.$ign.'</th>';
	  }
	}
      }
      $prevattempts.=&end_data_table_header_row();
      if ($getattempt eq '') {
	for ($version=1;$version<=$returnhash{'version'};$version++) {
            my @hidden;
            if (%typeparts) {
                foreach my $id (keys(%typeparts)) {
                    if (($returnhash{$version.':'.$id.'.type'} eq 'anonsurvey') || ($returnhash{$version.':'.$id.'.type'} eq 'anonsurveycred')) {
                        push(@hidden,$id);
                    }
                }
            }
            $prevattempts.=&start_data_table_row().
                           '<td>'.&mt('Transaction [_1]',$version).'</td>';
            if (@hidden) {
                foreach my $key (sort(keys(%lasthash))) {
                    my $hide;
                    foreach my $id (@hidden) {
                        if ($key =~ /^\Q$id\E/) {
                            $hide = 1;
                            last;
                        }
                    }
                    if ($hide) {
                        my ($id,$data) = ($key =~ /^(.+)\.([^.]+)$/);
                        if (($data eq 'award') || ($data eq 'awarddetail')) {
                            my $value = &format_previous_attempt_value($key,
                                             $returnhash{$version.':'.$key});
                            $prevattempts.='<td>'.$value.'&nbsp;</td>';
                        } else {
                            $prevattempts.='<td>&nbsp;</td>';
                        }
                    } else {
                        if ($key =~ /\./) {
                            my $value = &format_previous_attempt_value($key,
                                              $returnhash{$version.':'.$key});
                            $prevattempts.='<td>'.$value.'&nbsp;</td>';
                        } else {
                            $prevattempts.='<td>&nbsp;</td>';
                        }
                    }
                }
            } else {
	        foreach my $key (sort(keys(%lasthash))) {
		    my $value = &format_previous_attempt_value($key,
			            $returnhash{$version.':'.$key});
		    $prevattempts.='<td>'.$value.'&nbsp;</td>';
	        }
            }
	    $prevattempts.=&end_data_table_row();
	 }
      }
      my @currhidden = keys(%lasthidden);
      $prevattempts.=&start_data_table_row().'<td>'.&mt('Current').'</td>';
      foreach my $key (sort(keys(%lasthash))) {
          if (%typeparts) {
              my $hidden;
              foreach my $id (@currhidden) {
                  if ($key =~ /^\Q$id\E/) {
                      $hidden = 1;
                      last;
                  }
              }
              if ($hidden) {
                  my ($id,$data) = ($key =~ /^(.+)\.([^.]+)$/);
                  if (($data eq 'award') || ($data eq 'awarddetail')) {
                      my $value = &format_previous_attempt_value($key,$lasthash{$key});
                      if ($key =~/$regexp$/ && (defined &$gradesub)) {
                          $value = &$gradesub($value);
                      }
                      $prevattempts.='<td>'.$value.'&nbsp;</td>';
                  } else {
                      $prevattempts.='<td>&nbsp;</td>';
                  }
              } else {
                  my $value = &format_previous_attempt_value($key,$lasthash{$key});
                  if ($key =~/$regexp$/ && (defined &$gradesub)) {
                      $value = &$gradesub($value);
                  }
                  $prevattempts.='<td>'.$value.'&nbsp;</td>';
              }
          } else {
	      my $value = &format_previous_attempt_value($key,$lasthash{$key});
	      if ($key =~/$regexp$/ && (defined &$gradesub)) {
                  $value = &$gradesub($value);
              }
	      $prevattempts.='<td>'.$value.'&nbsp;</td>';
          }
      }
      $prevattempts.= &end_data_table_row().&end_data_table();
    } else {
      $prevattempts=
	  &start_data_table().&start_data_table_row().
	  '<td>'.&mt('Nothing submitted - no attempts.').'</td>'.
	  &end_data_table_row().&end_data_table();
    }
  } else {
    $prevattempts=
	  &start_data_table().&start_data_table_row().
	  '<td>'.&mt('No data.').'</td>'.
	  &end_data_table_row().&end_data_table();
  }
}

sub format_previous_attempt_value {
    my ($key,$value) = @_;
    if ($key =~ /timestamp/) {
	$value = &Apache::lonlocal::locallocaltime($value);
    } elsif (ref($value) eq 'ARRAY') {
	$value = '('.join(', ', @{ $value }).')';
    } else {
	$value = &unescape($value);
    }
    return $value;
}


sub relative_to_absolute {
    my ($url,$output)=@_;
    my $parser=HTML::TokeParser->new(\$output);
    my $token;
    my $thisdir=$url;
    my @rlinks=();
    while ($token=$parser->get_token) {
	if ($token->[0] eq 'S') {
	    if ($token->[1] eq 'a') {
		if ($token->[2]->{'href'}) {
		    $rlinks[$#rlinks+1]=$token->[2]->{'href'};
		}
	    } elsif ($token->[1] eq 'img' || $token->[1] eq 'embed' ) {
		$rlinks[$#rlinks+1]=$token->[2]->{'src'};
	    } elsif ($token->[1] eq 'base') {
		$thisdir=$token->[2]->{'href'};
	    }
	}
    }
    $thisdir=~s-/[^/]*$--;
    foreach my $link (@rlinks) {
	unless (($link=~/^https?\:\/\//i) ||
		($link=~/^\//) ||
		($link=~/^javascript:/i) ||
		($link=~/^mailto:/i) ||
		($link=~/^\#/)) {
	    my $newlocation=&Apache::lonnet::hreflocation($thisdir,$link);
	    $output=~s/(\"|\'|\=\s*)\Q$link\E(\"|\'|\s|\>)/$1$newlocation$2/;
	}
    }
# -------------------------------------------------- Deal with Applet codebases
    $output=~s/(\<applet[^\>]+)(codebase\=[^\S\>]+)*([^\>]*)\>/$1.($2?$2:' codebase="'.$thisdir.'"').$3.'>'/gei;
    return $output;
}

=pod

=item * &get_student_view()

show a snapshot of what student was looking at

=cut

sub get_student_view {
  my ($symb,$username,$domain,$courseid,$target,$moreenv) = @_;
  my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
  my (%form);
  my @elements=('symb','courseid','domain','username');
  foreach my $element (@elements) {
      $form{'grade_'.$element}=eval '$'.$element #'
  }
  if (defined($moreenv)) {
      %form=(%form,%{$moreenv});
  }
  if (defined($target)) { $form{'grade_target'} = $target; }
  $feedurl=&Apache::lonnet::clutter($feedurl);
  my ($userview,$response)=&Apache::lonnet::ssi_body($feedurl,%form);
  $userview=~s/\<body[^\>]*\>//gi;
  $userview=~s/\<\/body\>//gi;
  $userview=~s/\<html\>//gi;
  $userview=~s/\<\/html\>//gi;
  $userview=~s/\<head\>//gi;
  $userview=~s/\<\/head\>//gi;
  $userview=~s/action\s*\=/would_be_action\=/gi;
  $userview=&relative_to_absolute($feedurl,$userview);
  if (wantarray) {
     return ($userview,$response);
  } else {
     return $userview;
  }
}

sub get_student_view_with_retries {
  my ($symb,$retries,$username,$domain,$courseid,$target,$moreenv) = @_;

    my $ok = 0;                 # True if we got a good response.
    my $content;
    my $response;

    # Try to get the student_view done. within the retries count:
    
    do {
         ($content, $response) = &get_student_view($symb,$username,$domain,$courseid,$target,$moreenv);
         $ok      = $response->is_success;
         if (!$ok) {
            &Apache::lonnet::logthis("Failed get_student_view_with_retries on $symb: ".$response->is_success.', '.$response->code.', '.$response->message);
         }
         $retries--;
    } while (!$ok && ($retries > 0));
    
    if (!$ok) {
       $content = '';          # On error return an empty content.
    }
    if (wantarray) {
       return ($content, $response);
    } else {
       return $content;
    }
}

=pod

=item * &get_student_answers() 

show a snapshot of how student was answering problem

=cut

sub get_student_answers {
  my ($symb,$username,$domain,$courseid,%form) = @_;
  my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
  my (%moreenv);
  my @elements=('symb','courseid','domain','username');
  foreach my $element (@elements) {
    $moreenv{'grade_'.$element}=eval '$'.$element #'
  }
  $moreenv{'grade_target'}='answer';
  %moreenv=(%form,%moreenv);
  $feedurl = &Apache::lonnet::clutter($feedurl);
  my $userview=&Apache::lonnet::ssi($feedurl,%moreenv);
  return $userview;
}

=pod

=item * &submlink()

Inputs: $text $uname $udom $symb $target

Returns: A link to grades.pm such as to see the SUBM view of a student

=cut

###############################################
sub submlink {
    my ($text,$uname,$udom,$symb,$target)=@_;
    if (!($uname && $udom)) {
	(my $cursymb, my $courseid,$udom,$uname)=
	    &Apache::lonnet::whichuser($symb);
	if (!$symb) { $symb=$cursymb; }
    }
    if (!$symb) { $symb=&Apache::lonnet::symbread(); }
    $symb=&escape($symb);
    if ($target) { $target=" target=\"$target\""; }
    return
        '<a href="/adm/grades?command=submission'.
        '&amp;symb='.$symb.
        '&amp;student='.$uname.
        '&amp;userdom='.$udom.'"'.
        $target.'>'.$text.'</a>';
}
##############################################

=pod

=item * &pgrdlink()

Inputs: $text $uname $udom $symb $target

Returns: A link to grades.pm such as to see the PGRD view of a student

=cut

###############################################
sub pgrdlink {
    my $link=&submlink(@_);
    $link=~s/(&command=submission)/$1&showgrading=yes/;
    return $link;
}
##############################################

=pod

=item * &pprmlink()

Inputs: $text $uname $udom $symb $target

Returns: A link to parmset.pm such as to see the PPRM view of a
student and a specific resource

=cut

###############################################
sub pprmlink {
    my ($text,$uname,$udom,$symb,$target)=@_;
    if (!($uname && $udom)) {
	(my $cursymb, my $courseid,$udom,$uname)=
	    &Apache::lonnet::whichuser($symb);
	if (!$symb) { $symb=$cursymb; }
    }
    if (!$symb) { $symb=&Apache::lonnet::symbread(); }
    $symb=&escape($symb);
    if ($target) { $target="target=\"$target\""; }
    return '<a href="/adm/parmset?command=set&amp;'.
	'symb='.$symb.'&amp;uname='.$uname.
	'&amp;udom='.$udom.'" '.$target.'>'.$text.'</a>';
}
##############################################

=pod

=back

=cut

###############################################


sub timehash {
    my ($thistime) = @_;
    my $timezone = &Apache::lonlocal::gettimezone();
    my $dt = DateTime->from_epoch(epoch => $thistime)
                     ->set_time_zone($timezone);
    my $wday = $dt->day_of_week();
    if ($wday == 7) { $wday = 0; }
    return ( 'second' => $dt->second(),
             'minute' => $dt->minute(),
             'hour'   => $dt->hour(),
             'day'     => $dt->day_of_month(),
             'month'   => $dt->month(),
             'year'    => $dt->year(),
             'weekday' => $wday,
             'dayyear' => $dt->day_of_year(),
             'dlsav'   => $dt->is_dst() );
}

sub utc_string {
    my ($date)=@_;
    return strftime("%Y%m%dT%H%M%SZ",gmtime($date));
}

sub maketime {
    my %th=@_;
    my ($epoch_time,$timezone,$dt);
    $timezone = &Apache::lonlocal::gettimezone();
    eval {
        $dt = DateTime->new( year   => $th{'year'},
                             month  => $th{'month'},
                             day    => $th{'day'},
                             hour   => $th{'hour'},
                             minute => $th{'minute'},
                             second => $th{'second'},
                             time_zone => $timezone,
                         );
    };
    if (!$@) {
        $epoch_time = $dt->epoch;
        if ($epoch_time) {
            return $epoch_time;
        }
    }
    return POSIX::mktime(
        ($th{'seconds'},$th{'minutes'},$th{'hours'},
         $th{'day'},$th{'month'}-1,$th{'year'}-1900,0,0,-1));
}

#########################################

sub findallcourses {
    my ($roles,$uname,$udom) = @_;
    my %roles;
    if (ref($roles)) { %roles = map { $_ => 1 } @{$roles}; }
    my %courses;
    my $now=time;
    if (!defined($uname)) {
        $uname = $env{'user.name'};
    }
    if (!defined($udom)) {
        $udom = $env{'user.domain'};
    }
    if (($uname ne $env{'user.name'}) || ($udom ne $env{'user.domain'})) {
        my $extra = &Apache::lonnet::freeze_escape({'skipcheck' => 1});
        my %roleshash = &Apache::lonnet::dump('roles',$udom,$uname,'.',undef,
                                              $extra);
        if (!%roles) {
            %roles = (
                       cc => 1,
                       co => 1,
                       in => 1,
                       ep => 1,
                       ta => 1,
                       cr => 1,
                       st => 1,
             );
        }
        foreach my $entry (keys(%roleshash)) {
            my ($trole,$tend,$tstart) = split(/_/,$roleshash{$entry});
            if ($trole =~ /^cr/) { 
                next if (!exists($roles{$trole}) && !exists($roles{'cr'}));
            } else {
                next if (!exists($roles{$trole}));
            }
            if ($tend) {
                next if ($tend < $now);
            }
            if ($tstart) {
                next if ($tstart > $now);
            }
            my ($cdom,$cnum,$sec,$cnumpart,$secpart,$role,$realsec);
            (undef,$cdom,$cnumpart,$secpart) = split(/\//,$entry);
            if ($secpart eq '') {
                ($cnum,$role) = split(/_/,$cnumpart); 
                $sec = 'none';
                $realsec = '';
            } else {
                $cnum = $cnumpart;
                ($sec,$role) = split(/_/,$secpart);
                $realsec = $sec;
            }
            $courses{$cdom.'_'.$cnum}{$sec} = $trole.'/'.$cdom.'/'.$cnum.'/'.$realsec;
        }
    } else {
        foreach my $key (keys(%env)) {
	    if ( $key=~m{^user\.role\.(\w+)\./($match_domain)/($match_courseid)/?(\w*)$} ||
                 $key=~m{^user\.role\.(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_courseid)/?(\w*)$}) {
	        my ($role,$cdom,$cnum,$sec) = ($1,$2,$3,$4);
	        next if ($role eq 'ca' || $role eq 'aa');
	        next if (%roles && !exists($roles{$role}));
	        my ($starttime,$endtime)=split(/\./,$env{$key});
                my $active=1;
                if ($starttime) {
		    if ($now<$starttime) { $active=0; }
                }
                if ($endtime) {
                    if ($now>$endtime) { $active=0; }
                }
                if ($active) {
                    if ($sec eq '') {
                        $sec = 'none';
                    }
                    $courses{$cdom.'_'.$cnum}{$sec} = 
                                     $role.'/'.$cdom.'/'.$cnum.'/'.$sec;
                }
            }
        }
    }
    return %courses;
}

###############################################

sub blockcheck {
    my ($setters,$activity,$uname,$udom) = @_;

    if (!defined($udom)) {
        $udom = $env{'user.domain'};
    }
    if (!defined($uname)) {
        $uname = $env{'user.name'};
    }

    # If uname and udom are for a course, check for blocks in the course.

    if (&Apache::lonnet::is_course($udom,$uname)) {
        my %records = &Apache::lonnet::dump('comm_block',$udom,$uname);
        my ($startblock,$endblock)=&get_blocks($setters,$activity,$udom,$uname);
        return ($startblock,$endblock);
    }

    my $startblock = 0;
    my $endblock = 0;
    my %live_courses = &findallcourses(undef,$uname,$udom);

    # If uname is for a user, and activity is course-specific, i.e.,
    # boards, chat or groups, check for blocking in current course only.

    if (($activity eq 'boards' || $activity eq 'chat' ||
         $activity eq 'groups') && ($env{'request.course.id'})) {
        foreach my $key (keys(%live_courses)) {
            if ($key ne $env{'request.course.id'}) {
                delete($live_courses{$key});
            }
        }
    }

    my $otheruser = 0;
    my %own_courses;
    if ((($uname ne $env{'user.name'})) || ($udom ne $env{'user.domain'})) {
        # Resource belongs to user other than current user.
        $otheruser = 1;
        # Gather courses for current user
        %own_courses = 
            &findallcourses(undef,$env{'user.name'},$env{'user.domain'});
    }

    # Gather active course roles - course coordinator, instructor, 
    # exam proctor, ta, student, or custom role.

    foreach my $course (keys(%live_courses)) {
        my ($cdom,$cnum);
        if ((defined($env{'course.'.$course.'.domain'})) && (defined($env{'course.'.$course.'.num'}))) {
            $cdom = $env{'course.'.$course.'.domain'};
            $cnum = $env{'course.'.$course.'.num'};
        } else {
            ($cdom,$cnum) = split(/_/,$course); 
        }
        my $no_ownblock = 0;
        my $no_userblock = 0;
        if ($otheruser && $activity ne 'com') {
            # Check if current user has 'evb' priv for this
            if (defined($own_courses{$course})) {
                foreach my $sec (keys(%{$own_courses{$course}})) {
                    my $checkrole = 'cm./'.$cdom.'/'.$cnum;
                    if ($sec ne 'none') {
                        $checkrole .= '/'.$sec;
                    }
                    if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
                        $no_ownblock = 1;
                        last;
                    }
                }
            }
            # if they have 'evb' priv and are currently not playing student
            next if (($no_ownblock) &&
                 ($env{'request.role'} !~ m{^st\./$cdom/$cnum}));
        }
        foreach my $sec (keys(%{$live_courses{$course}})) {
            my $checkrole = 'cm./'.$cdom.'/'.$cnum;
            if ($sec ne 'none') {
                $checkrole .= '/'.$sec;
            }
            if ($otheruser) {
                # Resource belongs to user other than current user.
                # Assemble privs for that user, and check for 'evb' priv.
                my ($trole,$tdom,$tnum,$tsec);
                my $entry = $live_courses{$course}{$sec};
                if ($entry =~ /^cr/) {
                    ($trole,$tdom,$tnum,$tsec) = 
                      ($entry =~ m|^(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_username)/?(\w*)$|);
                } else {
                    ($trole,$tdom,$tnum,$tsec) = split(/\//,$entry);
                }
                my ($spec,$area,$trest,%allroles,%userroles);
                $area = '/'.$tdom.'/'.$tnum;
                $trest = $tnum;
                if ($tsec ne '') {
                    $area .= '/'.$tsec;
                    $trest .= '/'.$tsec;
                }
                $spec = $trole.'.'.$area;
                if ($trole =~ /^cr/) {
                    &Apache::lonnet::custom_roleprivs(\%allroles,$trole,
                                                      $tdom,$spec,$trest,$area);
                } else {
                    &Apache::lonnet::standard_roleprivs(\%allroles,$trole,
                                                       $tdom,$spec,$trest,$area);
                }
                my ($author,$adv) = &Apache::lonnet::set_userprivs(\%userroles,\%allroles);
                if ($userroles{'user.priv.'.$checkrole} =~ /evb\&([^\:]*)/) {
                    if ($1) {
                        $no_userblock = 1;
                        last;
                    }
                }
            } else {
                # Resource belongs to current user
                # Check for 'evb' priv via lonnet::allowed().
                if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
                    $no_ownblock = 1;
                    last;
                }
            }
        }
        # if they have the evb priv and are currently not playing student
        next if (($no_ownblock) &&
                 ($env{'request.role'} !~ m{^st\./\Q$cdom\E/\Q$cnum\E}));
        next if ($no_userblock);

        # Retrieve blocking times and identity of locker for course
        # of specified user, unless user has 'evb' privilege.
        
        my ($start,$end)=&get_blocks($setters,$activity,$cdom,$cnum);
        if (($start != 0) && 
            (($startblock == 0) || ($startblock > $start))) {
            $startblock = $start;
        }
        if (($end != 0)  &&
            (($endblock == 0) || ($endblock < $end))) {
            $endblock = $end;
        }
    }
    return ($startblock,$endblock);
}

sub get_blocks {
    my ($setters,$activity,$cdom,$cnum) = @_;
    my $startblock = 0;
    my $endblock = 0;
    my $course = $cdom.'_'.$cnum;
    $setters->{$course} = {};
    $setters->{$course}{'staff'} = [];
    $setters->{$course}{'times'} = [];
    my %records = &Apache::lonnet::dump('comm_block',$cdom,$cnum);
    foreach my $record (keys(%records)) {
        my ($start,$end) = ($record =~ m/^(\d+)____(\d+)$/);
        if ($start <= time && $end >= time) {
            my ($staff_name,$staff_dom,$title,$blocks) =
                &parse_block_record($records{$record});
            if ($blocks->{$activity} eq 'on') {
                push(@{$$setters{$course}{'staff'}},[$staff_name,$staff_dom]);
                push(@{$$setters{$course}{'times'}}, [$start,$end]);
                if ( ($startblock == 0) || ($startblock > $start) ) {
                    $startblock = $start;
                }
                if ( ($endblock == 0) || ($endblock < $end) ) {
                    $endblock = $end;
                }
            }
        }
    }
    return ($startblock,$endblock);
}

sub parse_block_record {
    my ($record) = @_;
    my ($setuname,$setudom,$title,$blocks);
    if (ref($record) eq 'HASH') {
        ($setuname,$setudom) = split(/:/,$record->{'setter'});
        $title = &unescape($record->{'event'});
        $blocks = $record->{'blocks'};
    } else {
        my @data = split(/:/,$record,3);
        if (scalar(@data) eq 2) {
            $title = $data[1];
            ($setuname,$setudom) = split(/@/,$data[0]);
        } else {
            ($setuname,$setudom,$title) = @data;
        }
        $blocks = { 'com' => 'on' };
    }
    return ($setuname,$setudom,$title,$blocks);
}

sub blocking_status {
  my ($activity,$uname,$udom) = @_;
  my %setters;

  # check for active blocking
  my ($startblock,$endblock)=&blockcheck(\%setters,$activity,$uname,$udom);

  my $blocked = $startblock && $endblock ? 1 : 0;

  # caller just wants to know whether a block is active
  if (!wantarray) { return $blocked; }

  # build a link to a popup window containing the details
  my $querystring  = "?activity=$activity";
  # $uname and $udom decide whose portfolio the user is trying to look at
     $querystring .= "&amp;udom=$udom"      if $udom;
     $querystring .= "&amp;uname=$uname"    if $uname;

  my $output .= <<'END_MYBLOCK';
    function openWindow(url, wdwName, w, h, toolbar,scrollbar) {
        var options = "width=" + w + ",height=" + h + ",";
        options += "resizable=yes,scrollbars="+scrollbar+",status=no,";
        options += "menubar=no,toolbar="+toolbar+",location=no,directories=no";
        var newWin = window.open(url, wdwName, options);
        newWin.focus();
    }
END_MYBLOCK

  $output = Apache::lonhtmlcommon::scripttag($output);
  
  my $popupUrl = "/adm/blockingstatus/$querystring";
  my $text = mt('Communication Blocked');

  $output .= <<"END_BLOCK";
<div class='LC_comblock'>
  <a onclick='openWindow("$popupUrl","Blocking Table",600,300,"no","no");return false;' href='/adm/blockingstatus/$querystring'
  title='$text'>
  <img class='LC_noBorder LC_middle' title='$text' src='/res/adm/pages/comblock.png' alt='$text'/></a>
  <a onclick='openWindow("$popupUrl","Blocking Table",600,300,"no","no");return false;' href='/adm/blockingstatus/$querystring' 
  title='$text'>$text</a>
</div>

END_BLOCK

  return ($blocked, $output);
}

###############################################

sub check_ip_acc {
    my ($acc)=@_;
    &Apache::lonxml::debug("acc is $acc");
    if (!defined($acc) || $acc =~ /^\s*$/ || $acc =~/^\s*no\s*$/i) {
        return 1;
    }
    my $allowed=0;
    my $ip=$env{'request.host'} || $ENV{'REMOTE_ADDR'};

    my $name;
    foreach my $pattern (split(',',$acc)) {
        $pattern =~ s/^\s*//;
        $pattern =~ s/\s*$//;
        if ($pattern =~ /\*$/) {
            #35.8.*
            $pattern=~s/\*//;
            if ($ip =~ /^\Q$pattern\E/) { $allowed=1; }
        } elsif ($pattern =~ /(\d+\.\d+\.\d+)\.\[(\d+)-(\d+)\]$/) {
            #35.8.3.[34-56]
            my $low=$2;
            my $high=$3;
            $pattern=$1;
            if ($ip =~ /^\Q$pattern\E/) {
                my $last=(split(/\./,$ip))[3];
                if ($last <=$high && $last >=$low) { $allowed=1; }
            }
        } elsif ($pattern =~ /^\*/) {
            #*.msu.edu
            $pattern=~s/\*//;
            if (!defined($name)) {
                use Socket;
                my $netaddr=inet_aton($ip);
                ($name)=gethostbyaddr($netaddr,AF_INET);
            }
            if ($name =~ /\Q$pattern\E$/i) { $allowed=1; }
        } elsif ($pattern =~ /\d+\.\d+\.\d+\.\d+/) {
            #127.0.0.1
            if ($ip =~ /^\Q$pattern\E/) { $allowed=1; }
        } else {
            #some.name.com
            if (!defined($name)) {
                use Socket;
                my $netaddr=inet_aton($ip);
                ($name)=gethostbyaddr($netaddr,AF_INET);
            }
            if ($name =~ /\Q$pattern\E$/i) { $allowed=1; }
        }
        if ($allowed) { last; }
    }
    return $allowed;
}

###############################################

=pod

=head1 Domain Template Functions

=over 4

=item * &determinedomain()

Inputs: $domain (usually will be undef)

Returns: Determines which domain should be used for designs

=cut

###############################################
sub determinedomain {
    my $domain=shift;
    if (! $domain) {
        # Determine domain if we have not been given one
        $domain = &Apache::lonnet::default_login_domain();
        if ($env{'user.domain'}) { $domain=$env{'user.domain'}; }
        if ($env{'request.role.domain'}) { 
            $domain=$env{'request.role.domain'}; 
        }
    }
    return $domain;
}
###############################################

sub devalidate_domconfig_cache {
    my ($udom)=@_;
    &Apache::lonnet::devalidate_cache_new('domainconfig',$udom);
}

# ---------------------- Get domain configuration for a domain
sub get_domainconf {
    my ($udom) = @_;
    my $cachetime=1800;
    my ($result,$cached)=&Apache::lonnet::is_cached_new('domainconfig',$udom);
    if (defined($cached)) { return %{$result}; }

    my %domconfig = &Apache::lonnet::get_dom('configuration',
					     ['login','rolecolors','autoenroll'],$udom);
    my (%designhash,%legacy);
    if (keys(%domconfig) > 0) {
        if (ref($domconfig{'login'}) eq 'HASH') {
            if (keys(%{$domconfig{'login'}})) {
                foreach my $key (keys(%{$domconfig{'login'}})) {
                    if (ref($domconfig{'login'}{$key}) eq 'HASH') {
                        if ($key eq 'loginvia') {
                            if (ref($domconfig{'login'}{'loginvia'}) eq 'HASH') {
                                my @ids = &Apache::lonnet::current_machine_ids();
                                foreach my $hostname (@ids) {
                                    if (ref($domconfig{'login'}{'loginvia'}{$hostname}) eq 'HASH') {
                                        if ($domconfig{'login'}{'loginvia'}{$hostname}{'server'}) {
                                            my $server = $domconfig{'login'}{'loginvia'}{$hostname}{'server'};
                                            $designhash{$udom.'.login.loginvia'} = $server;
                                            if ($domconfig{'login'}{'loginvia'}{$hostname}{'serverpath'} eq 'custom') {

                                                $designhash{$udom.'.login.loginvia_'.$hostname} = $server.':'.$domconfig{'login'}{'loginvia'}{$hostname}{'custompath'};
                                            } else {
                                                 $designhash{$udom.'.login.loginvia_'.$hostname} = $server.':'.$domconfig{'login'}{'loginvia'}{$hostname}{'serverpath'};
                                            }
                                            if ($domconfig{'login'}{'loginvia'}{$hostname}{'exempt'}) {
                                                $designhash{$udom.'.login.loginvia_exempt_'.$hostname} = $domconfig{'login'}{'loginvia'}{$hostname}{'exempt'};
                                            }
                                        }
                                    }
                                }
                            }
                        } else {
                            foreach my $img (keys(%{$domconfig{'login'}{$key}})) {
                                $designhash{$udom.'.login.'.$key.'_'.$img} = 
                                    $domconfig{'login'}{$key}{$img};
                            }
                        }
                    } else {
                        $designhash{$udom.'.login.'.$key}=$domconfig{'login'}{$key};
                    }
                }
            } else {
                $legacy{'login'} = 1;
            }
        } else {
            $legacy{'login'} = 1;
        }
        if (ref($domconfig{'rolecolors'}) eq 'HASH') {
            if (keys(%{$domconfig{'rolecolors'}})) {
                foreach my $role (keys(%{$domconfig{'rolecolors'}})) {
                    if (ref($domconfig{'rolecolors'}{$role}) eq 'HASH') {
                        foreach my $item (keys(%{$domconfig{'rolecolors'}{$role}})) {
                            $designhash{$udom.'.'.$role.'.'.$item}=$domconfig{'rolecolors'}{$role}{$item};
                        }
                    }
                }
            } else {
                $legacy{'rolecolors'} = 1;
            }
        } else {
            $legacy{'rolecolors'} = 1;
        }
        if (ref($domconfig{'autoenroll'}) eq 'HASH') {
            if ($domconfig{'autoenroll'}{'co-owners'}) {
                $designhash{$udom.'.autoassign.co-owners'}=$domconfig{'autoenroll'}{'co-owners'};
            }
        }
        if (keys(%legacy) > 0) {
            my %legacyhash = &get_legacy_domconf($udom);
            foreach my $item (keys(%legacyhash)) {
                if ($item =~ /^\Q$udom\E\.login/) {
                    if ($legacy{'login'}) { 
                        $designhash{$item} = $legacyhash{$item};
                    }
                } else {
                    if ($legacy{'rolecolors'}) {
                        $designhash{$item} = $legacyhash{$item};
                    }
                }
            }
        }
    } else {
        %designhash = &get_legacy_domconf($udom); 
    }
    &Apache::lonnet::do_cache_new('domainconfig',$udom,\%designhash,
				  $cachetime);
    return %designhash;
}

sub get_legacy_domconf {
    my ($udom) = @_;
    my %legacyhash;
    my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
    my $designfile =  $designdir.'/'.$udom.'.tab';
    if (-e $designfile) {
        if ( open (my $fh,"<$designfile") ) {
            while (my $line = <$fh>) {
                next if ($line =~ /^\#/);
                chomp($line);
                my ($key,$val)=(split(/\=/,$line));
                if ($val) { $legacyhash{$udom.'.'.$key}=$val; }
            }
            close($fh);
        }
    }
    if (-e '/home/httpd/html/adm/lonDomLogos/'.$udom.'.gif') {
        $legacyhash{$udom.'.login.domlogo'} = "/adm/lonDomLogos/$udom.gif";
    }
    return %legacyhash;
}

=pod

=item * &domainlogo()

Inputs: $domain (usually will be undef)

Returns: A link to a domain logo, if the domain logo exists.
If the domain logo does not exist, a description of the domain.

=cut

###############################################
sub domainlogo {
    my $domain = &determinedomain(shift);
    my %designhash = &get_domainconf($domain);    
    # See if there is a logo
    if ($designhash{$domain.'.login.domlogo'} ne '') {
        my $imgsrc = $designhash{$domain.'.login.domlogo'};
        if ($imgsrc =~ m{^/(adm|res)/}) {
	    if ($imgsrc =~ m{^/res/}) {
		my $local_name = &Apache::lonnet::filelocation('',$imgsrc);
		&Apache::lonnet::repcopy($local_name);
	    }
	   $imgsrc = &lonhttpdurl($imgsrc);
        } 
        return '<img src="'.$imgsrc.'" alt="'.$domain.'" />';
    } elsif (defined(&Apache::lonnet::domain($domain,'description'))) {
        return &Apache::lonnet::domain($domain,'description');
    } else {
        return '';
    }
}
##############################################

=pod

=item * &designparm()

Inputs: $which parameter; $domain (usually will be undef)

Returns: value of designparamter $which

=cut


##############################################
sub designparm {
    my ($which,$domain)=@_;
    if (exists($env{'environment.color.'.$which})) {
        return $env{'environment.color.'.$which};
    }
    $domain=&determinedomain($domain);
    my %domdesign = &get_domainconf($domain);
    my $output;
    if ($domdesign{$domain.'.'.$which} ne '') {
        $output = $domdesign{$domain.'.'.$which};
    } else {
        $output = $defaultdesign{$which};
    }
    if (($which =~ /^(student|coordinator|author|admin)\.img$/) ||
        ($which =~ /login\.(img|logo|domlogo|login)/)) {
        if ($output =~ m{^/(adm|res)/}) {
            if ($output =~ m{^/res/}) {
                my $local_name = &Apache::lonnet::filelocation('',$output);
                &Apache::lonnet::repcopy($local_name);
            }
            $output = &lonhttpdurl($output);
        }
    }
    return $output;
}

##############################################
=pod

=item * &authorspace()

Inputs: ./.

Returns: Path to the Construction Space of the current user's
         accessed author space
         The author space will be that of the current user
         when accessing the own author space
         and that of the co-author/assistent co-author
         when accessing the co-author's/assistent co-author's
         space

=cut

sub authorspace {
    my $caname = '';
    if ($env{'request.role'} =~ /^ca|^aa/) {
        (undef,$caname) =
            ($env{'request.role'}=~/($match_domain)\/($match_username)$/);
    } else {
        $caname = $env{'user.name'};
    }
    return '/priv/'.$caname.'/';
}

##############################################
=pod

=item * &head_subbox()

Inputs: $content (contains HTML code with page functions, etc.)

Returns: HTML div with $content
         To be included in page header

=cut

sub head_subbox {
    my ($content)=@_;
    my $output =
        '<div id="LC_head_subbox">'
       .$content
       .'</div>'
}

##############################################
=pod

=item * &CSTR_pageheader()

Inputs: ./.

Returns: HTML div with CSTR path and recent box
         To be included on Construction Space pages

=cut

sub CSTR_pageheader {
    # this is for resources; directories have customtitle, and crumbs
            # and select recent are created in lonpubdir.pm  
    my ($uname,$thisdisfn)=
        ($env{'request.filename'} =~ m|^/home/([^/]+)/public_html/(.*)|);
    my $formaction='/priv/'.$uname.'/'.$thisdisfn;
    $formaction=~s/\/+/\//g;

    my $parentpath = '';
    my $lastitem = '';
    if ($thisdisfn =~ m-(.+/)([^/]*)$-) {
        $parentpath = $1;
        $lastitem = $2;
    } else {
        $lastitem = $thisdisfn;
    }

    my $output =
         '<div>'
        .&Apache::loncommon::help_open_menu('','',3,'Authoring') #FIXME: Broken? Where is it?
        .'<b>'.&mt('Construction Space:').'</b> '
        .'<form name="dirs" method="post" action="'.$formaction
        .'" target="_top">' #FIXME lonpubdir: target="_parent"
        .&Apache::lonhtmlcommon::crumbs($uname.'/'.$parentpath,'_top','/priv',undef,undef);

    if ($lastitem) {
        $output .=
             '<span class="LC_filename">'
            .$lastitem
            .'</span>';
    }
    $output .=
         '<br />'
        #FIXME lonpubdir: &Apache::lonhtmlcommon::crumbs($uname.$thisdisfn.'/','_top','/priv','','+1',1)."</b></tt><br />"
        .&Apache::lonhtmlcommon::select_recent('construct','recent','this.form.action=this.form.recent.value;this.form.submit()')
        .'</form>'
        .&Apache::lonmenu::constspaceform()
        .'</div>';

    return $output;
}

###############################################
###############################################

=pod

=back

=head1 HTML Helpers

=over 4

=item * &bodytag()

Returns a uniform header for LON-CAPA web pages.

Inputs: 

=over 4

=item * $title, A title to be displayed on the page.

=item * $function, the current role (can be undef).

=item * $addentries, extra parameters for the <body> tag.

=item * $bodyonly, if defined, only return the <body> tag.

=item * $domain, if defined, force a given domain.

=item * $forcereg, if page should register as content page (relevant for 
            text interface only)

=item * $no_nav_bar, if true, keep the 'what is this' info but remove the
                     navigational links

=item * $bgcolor, used to override the bgcolor on a webpage to a specific value

=item * $args, optional argument valid values are
            no_auto_mt_title -> prevents &mt()ing the title arg
            inherit_jsmath -> when creating popup window in a page,
                              should it have jsmath forced on by the
                              current page

=back

Returns: A uniform header for LON-CAPA web pages.  
If $bodyonly is nonzero, a string containing a <body> tag will be returned.
If $bodyonly is undef or zero, an html string containing a <body> tag and 
other decorations will be returned.

=cut

sub bodytag {
    my ($title,$function,$addentries,$bodyonly,$domain,$forcereg,
        $no_nav_bar,$bgcolor,$args)=@_;

    my $public;
    if ((($env{'user.name'} eq 'public') && ($env{'user.domain'} eq 'public'))
        || ($env{'user.name'} eq '') && ($env{'user.domain'} eq '')) {
        $public = 1;
    }
    if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }

    $function = &get_users_function() if (!$function);
    my $img =    &designparm($function.'.img',$domain);
    my $font =   &designparm($function.'.font',$domain);
    my $pgbg   = $bgcolor || &designparm($function.'.pgbg',$domain);

    my %design = ( 'style'   => 'margin-top: 0',
		   'bgcolor' => $pgbg,
		   'text'    => $font,
                   'alink'   => &designparm($function.'.alink',$domain),
		   'vlink'   => &designparm($function.'.vlink',$domain),
		   'link'    => &designparm($function.'.link',$domain),);
    @design{keys(%$addentries)} = @$addentries{keys(%$addentries)}; 

 # role and realm
    my ($role,$realm) = split(/\./,$env{'request.role'},2);
    if ($role  eq 'ca') {
        my ($rdom,$rname) = ($realm =~ m{^/($match_domain)/($match_username)$});
        $realm = &plainname($rname,$rdom);
    } 
# realm
    if ($env{'request.course.id'}) {
        if ($env{'request.role'} !~ /^cr/) {
            $role = &Apache::lonnet::plaintext($role,&course_type());
        }
        if ($env{'request.course.sec'}) {
            $role .= ('&nbsp;'x2).'-&nbsp;'.&mt('section:').'&nbsp;'.$env{'request.course.sec'};
        }   
	$realm = $env{'course.'.$env{'request.course.id'}.'.description'};
    } else {
        $role = &Apache::lonnet::plaintext($role);
    }

    if (!$realm) { $realm='&nbsp;'; }

    my $extra_body_attr = &make_attr_string($forcereg,\%design);

# construct main body tag
    my $bodytag = "<body $extra_body_attr>".
	&Apache::lontexconvert::init_math_support($args->{'inherit_jsmath'});

    if ($bodyonly) {
        return $bodytag;
    } 

    my $name = &plainname($env{'user.name'},$env{'user.domain'});
    if ($public) {
	undef($role);
    } else {
	$name = &aboutmewrapper($name,$env{'user.name'},$env{'user.domain'});
    }
    
    my $titleinfo = '<h1>'.$title.'</h1>';
    #
    # Extra info if you are the DC
    my $dc_info = '';
    if ($env{'user.adv'} && exists($env{'user.role.dc./'.
                        $env{'course.'.$env{'request.course.id'}.
                                 '.domain'}.'/'})) {
        my $cid = $env{'request.course.id'};
        $dc_info = $cid.' '.$env{'course.'.$cid.'.internal.coursecode'};
        $dc_info =~ s/\s+$//;
    }

    $role = '<span class="LC_nobreak">('.$role.')</span>' if $role;
    &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);

        if ($no_nav_bar || $env{'form.inhibitmenu'} eq 'yes') { 
            return $bodytag; 
        } 

        if ($env{'request.state'} eq 'construct') { $forcereg=1; }

        #    if ($env{'request.state'} eq 'construct') {
        #        $titleinfo = &CSTR_pageheader(); #FIXME: Will be removed once all scripts have their own calls
        #    }



        if ($env{'request.noversionuri'} =~ m{^/res/adm/pages/}) {
             if ($dc_info) {
                 $dc_info = qq|<span class="LC_cusr_subheading">$dc_info</span>|;
             }
             $bodytag .= qq|<div id="LC_nav_bar">$name $role<br />
                <em>$realm</em> $dc_info</div>|;
            return $bodytag;
        }

        unless ($env{'request.symb'} =~ m/\.page___\d+___/) {
            $bodytag .= qq|<div id="LC_nav_bar">$name $role</div>|;
        }

        $bodytag .= Apache::lonhtmlcommon::scripttag(
            Apache::lonmenu::utilityfunctions(), 'start');

        $bodytag .= Apache::lonmenu::primary_menu();

        if ($dc_info) {
            $dc_info = &dc_courseid_toggle($dc_info);
        }
        $bodytag .= qq|<div id="LC_realm">$realm $dc_info</div>|;

        #don't show menus for public users
        if (!$public){
            $bodytag .= Apache::lonmenu::secondary_menu();
            $bodytag .= Apache::lonmenu::serverform();
            $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end');
            if ($env{'request.state'} eq 'construct') {
                $bodytag .= &Apache::lonmenu::innerregister($forcereg,
                                $args->{'bread_crumbs'});
            } elsif ($forcereg) { 
                $bodytag .= &Apache::lonmenu::innerregister($forcereg);
            }
        }else{
            # this is to seperate menu from content when there's no secondary
            # menu. Especially needed for public accessible ressources.
            $bodytag .= '<hr style="clear:both" />';
            $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end'); 
        }

        return $bodytag;
}

sub dc_courseid_toggle {
    my ($dc_info) = @_;
    return ' <span id="dccidtext" class="LC_cusr_subheading LC_nobreak">'.
           '<a href="javascript:showCourseID();">'.
           &mt('(More ...)').'</a></span>'.
           '<div id="dccid" class="LC_dccid">'.$dc_info.'</div>';
}

sub make_attr_string {
    my ($register,$attr_ref) = @_;

    if ($attr_ref && !ref($attr_ref)) {
	die("addentries Must be a hash ref ".
	    join(':',caller(1))." ".
	    join(':',caller(0))." ");
    }

    if ($register) {
	my ($on_load,$on_unload);
	foreach my $key (keys(%{$attr_ref})) {
	    if      (lc($key) eq 'onload') {
		$on_load.=$attr_ref->{$key}.';';
		delete($attr_ref->{$key});

	    } elsif (lc($key) eq 'onunload') {
		$on_unload.=$attr_ref->{$key}.';';
		delete($attr_ref->{$key});
	    }
	}
	$attr_ref->{'onload'}  = $on_load;
	$attr_ref->{'onunload'}= $on_unload;
    }

    my $attr_string;
    foreach my $attr (keys(%$attr_ref)) {
	$attr_string .= " $attr=\"".$attr_ref->{$attr}.'" ';
    }
    return $attr_string;
}


###############################################
###############################################

=pod

=item * &endbodytag()

Returns a uniform footer for LON-CAPA web pages.

Inputs: 1 - optional reference to an args hash
If in the hash, key for noredirectlink has a value which evaluates to true,
a 'Continue' link is not displayed if the page contains an
internal redirect in the <head></head> section,
i.e., $env{'internal.head.redirect'} exists   

=cut

sub endbodytag {
    my ($args) = @_;
    my $endbodytag='</body>';
    $endbodytag=&Apache::lontexconvert::jsMath_process()."\n".$endbodytag;
    if ( exists( $env{'internal.head.redirect'} ) ) {
        if (!(ref($args) eq 'HASH' && $args->{'noredirectlink'})) {
	    $endbodytag=
	        "<br /><a href=\"$env{'internal.head.redirect'}\">".
	        &mt('Continue').'</a>'.
	        $endbodytag;
        }
    }
    return $endbodytag;
}

=pod

=item * &standard_css()

Returns a style sheet

Inputs: (all optional)
            domain         -> force to color decorate a page for a specific
                               domain
            function       -> force usage of a specific rolish color scheme
            bgcolor        -> override the default page bgcolor

=cut

sub standard_css {
    my ($function,$domain,$bgcolor) = @_;
    $function  = &get_users_function() if (!$function);
    my $img    = &designparm($function.'.img',   $domain);
    my $tabbg  = &designparm($function.'.tabbg', $domain);
    my $font   = &designparm($function.'.font',  $domain);
    my $fontmenu = &designparm($function.'.fontmenu', $domain);
#second colour for later usage
    my $sidebg = &designparm($function.'.sidebg',$domain);
    my $pgbg_or_bgcolor =
	         $bgcolor ||
	         &designparm($function.'.pgbg',  $domain);
    my $pgbg   = &designparm($function.'.pgbg',  $domain);
    my $alink  = &designparm($function.'.alink', $domain);
    my $vlink  = &designparm($function.'.vlink', $domain);
    my $link   = &designparm($function.'.link',  $domain);

    my $sans                 = 'Verdana,Arial,Helvetica,sans-serif';
    my $mono                 = 'monospace';
    my $data_table_head      = $sidebg;
    my $data_table_light     = '#FAFAFA';
    my $data_table_dark      = '#F0F0F0';
    my $data_table_darker    = '#CCCCCC';
    my $data_table_highlight = '#FFFF00';
    my $mail_new             = '#FFBB77';
    my $mail_new_hover       = '#DD9955';
    my $mail_read            = '#BBBB77';
    my $mail_read_hover      = '#999944';
    my $mail_replied         = '#AAAA88';
    my $mail_replied_hover   = '#888855';
    my $mail_other           = '#99BBBB';
    my $mail_other_hover     = '#669999';
    my $table_header         = '#DDDDDD';
    my $feedback_link_bg     = '#BBBBBB';
    my $lg_border_color      = '#C8C8C8';
    my $button_hover         = '#BF2317';

    my $border = ($env{'browser.type'} eq 'explorer' ||
      $env{'browser.type'} eq 'safari'     ) ? '0 2px 0 2px'
                                             : '0 3px 0 4px';


    return <<END;

/* needed for iframe to allow 100% height in FF */
body, html { 
    margin: 0;
    padding: 0 0.5%;
    height: 99%; /* to avoid scrollbars */
}

body {
  font-family: $sans;
  line-height:130%;
  font-size:0.83em;
  color:$font;
}

a:focus,
a:focus img {
  color: red;
  background: yellow;
}

form, .inline {
  display: inline;
}

LC_right {
  text-align:right;
}

LC_middle {
  vertical-align:middle;
}

LC_400Box {
  width:400px;
}

LC_iframecontainer {
    width: 98%;
    margin: 0;
    position: fixed;
    top: 8.5em;
    bottom: 0;
}

LC_iframecontainer iframe{
    border: none;
    width: 100%;
    height: 100%;
}

LC_filename {
  font-family: $mono;
  white-space:pre;
  font-size: 120%;
}

LC_fileicon {
  border: none;
  height: 1.3em;
  vertical-align: text-bottom;
  margin-right: 0.3em;
  text-decoration:none;
}

LC_error {
  color: red;
  font-size: larger;
}

LC_warning,
LC_diff_removed {
  color: red;
}

LC_info,
LC_success,
LC_diff_added {
  color: green;
}

div.LC_confirm_box {
  background-color: #FAFAFA;
  border: 1px solid $lg_border_color;
  margin-right: 0;
  padding: 5px;
}

div.LC_confirm_box .LC_error img,
div.LC_confirm_box .LC_success img {
  vertical-align: middle;
}

LC_icon {
  border: none;
  vertical-align: middle;
}

LC_docs_spacer {
  width: 25px;
  height: 1px;
  border: none;
}

LC_internal_info {
  color: #999999;
}

LC_discussion {
  background: $tabbg;
  border: 1px solid black;
  margin: 2px;
}

LC_disc_action_links_bar {
  background: $tabbg;
  border: none;
  margin: 4px;
}

LC_disc_action_left {
  text-align: left;
}

LC_disc_action_right {
  text-align: right;
}

LC_disc_new_item {
  background: white;
  border: 2px solid red;
  margin: 2px;
}

LC_disc_old_item {
  background: white;
  border: 1px solid black;
  margin: 2px;
}

table.LC_pastsubmission {
  border: 1px solid black;
  margin: 2px;
}

table#LC_menubuttons {
  width: 100%;
  background: $pgbg;
  border: 2px;
  border-collapse: separate;
  padding: 0;
}

table#LC_title_bar a {
  color: $fontmenu;
}

table#LC_title_bar {
  clear: both;
  display: none;
}

table#LC_title_bar,
table.LC_breadcrumbs, /* obsolete? */
table#LC_title_bar.LC_with_remote {
  width: 100%;
  border-color: $pgbg;
  border-style: solid;
  border-width: $border;
  background: $pgbg;
  color: $fontmenu;
  border-collapse: collapse;
  padding: 0;
  margin: 0;
}

ul.LC_breadcrumb_tools_outerlist {
    margin: 0;
    padding: 0;
    position: relative;
    list-style: none;
}
ul.LC_breadcrumb_tools_outerlist li {
    display: inline;
}

LC_breadcrumb_tools_navigation {
    padding: 0;
    margin: 0;
    float: left;
}
LC_breadcrumb_tools_tools {
    padding: 0;
    margin: 0;
    float: right;
}

table#LC_title_bar td {
  background: $tabbg;
}

table#LC_menubuttons img {
  border: none;
}

LC_breadcrumbs_component {
  float: right;
  margin: 0 1em;
}
LC_breadcrumbs_component img {
  vertical-align: middle;
}

td.LC_table_cell_checkbox {
  text-align: center;
}

LC_fontsize_small {
  font-size: 70%;
}

#LC_breadcrumbs {
  clear:both;
  background: $sidebg;
  border-bottom: 1px solid $lg_border_color;
  line-height: 2.5em;
  overflow: hidden;
  margin: 0;
  padding: 0;
}

#LC_head_subbox {
  clear:both;
  background: #F8F8F8; /* $sidebg; */
  border: 1px solid $sidebg;
  margin: 0 0 10px 0;      
  padding: 3px;
}

LC_fontsize_medium {
  font-size: 85%;
}

LC_fontsize_large {
  font-size: 120%;
}

LC_menubuttons_inline_text {
  color: $font;
  font-size: 90%;
  padding-left:3px;
}

LC_menubuttons_inline_text img{
  vertical-align: middle;
}

li.LC_menubuttons_inline_text img,a {
  cursor:pointer;
}

LC_menubuttons_link {
  text-decoration: none;
}

LC_menubuttons_category {
  color: $font;
  background: $pgbg;
  font-size: larger;
  font-weight: bold;
}

td.LC_menubuttons_text {
  color: $font;
}

LC_current_location {
  background: $tabbg;
}

table.LC_data_table {
  border: 1px solid #000000;
  border-collapse: separate;
  border-spacing: 1px;
  background: $pgbg;
}

LC_data_table_dense {
  font-size: small;
}

table.LC_nested_outer {
  border: 1px solid #000000;
  border-collapse: collapse;
  border-spacing: 0;
  width: 100%;
}

table.LC_innerpickbox,
table.LC_nested {
  border: none;
  border-collapse: collapse;
  border-spacing: 0;
  width: 100%;
}

ui-accordion,
ui-accordion table.LC_data_table,
ui-accordion table.LC_nested_outer{
  border: 0px;
  border-spacing: 0px;
  margin: 3px;
}

table.LC_data_table tr th,
table.LC_calendar tr th,
table.LC_prior_tries tr th,
table.LC_innerpickbox tr th {
  font-weight: bold;
  background-color: $data_table_head;
  color:$fontmenu;
  font-size:90%;
}

table.LC_innerpickbox tr th,
table.LC_innerpickbox tr td {
  vertical-align: top;
}

table.LC_data_table tr.LC_info_row > td {
  background-color: #CCCCCC;
  font-weight: bold;
  text-align: left;
}

table.LC_data_table tr.LC_odd_row > td {
  background-color: $data_table_light;
  padding: 2px;
  vertical-align: top;
}

table.LC_pick_box tr > td.LC_odd_row {
  background-color: $data_table_light;
  vertical-align: top;
}

table.LC_data_table tr.LC_even_row > td {
  background-color: $data_table_dark;
  padding: 2px;
  vertical-align: top;
}

table.LC_pick_box tr > td.LC_even_row {
  background-color: $data_table_dark;
  vertical-align: top;
}

table.LC_data_table tr.LC_data_table_highlight td {
  background-color: $data_table_darker;
}

table.LC_data_table tr td.LC_leftcol_header {
  background-color: $data_table_head;
  font-weight: bold;
}

table.LC_data_table tr.LC_empty_row td,
table.LC_nested tr.LC_empty_row td {
  font-weight: bold;
  font-style: italic;
  text-align: center;
  padding: 8px;
}

table.LC_data_table tr.LC_empty_row td {
  background-color: $sidebg;
}

table.LC_nested tr.LC_empty_row td {
  background-color: #FFFFFF;
}

table.LC_caption {
}

table.LC_nested tr.LC_empty_row td {
  padding: 4ex
}

table.LC_nested_outer tr th {
  font-weight: bold;
  color:$fontmenu;
  background-color: $data_table_head;
  font-size: small;
  border-bottom: 1px solid #000000;
}

table.LC_nested_outer tr td.LC_subheader {
  background-color: $data_table_head;
  font-weight: bold;
  font-size: small;
  border-bottom: 1px solid #000000;
  text-align: right;
}

table.LC_nested tr.LC_info_row td {
  background-color: #CCCCCC;
  font-weight: bold;
  font-size: small;
  text-align: center;
}

table.LC_nested tr.LC_info_row td.LC_left_item,
table.LC_nested_outer tr th.LC_left_item {
  text-align: left;
}

table.LC_nested td {
  background-color: #FFFFFF;
  font-size: small;
}

table.LC_nested_outer tr th.LC_right_item,
table.LC_nested tr.LC_info_row td.LC_right_item,
table.LC_nested tr.LC_odd_row td.LC_right_item,
table.LC_nested tr td.LC_right_item {
  text-align: right;
}

ui-accordion table.LC_nested tr.LC_odd_row td.LC_left_item,
ui-accordion table.LC_nested tr.LC_even_row td.LC_left_item {
  text-align: right;
  width: 40%;
  padding-right:10px;
  vertical-align: top;
  padding: 5px;
}

ui-accordion table.LC_nested tr.LC_odd_row td.LC_right_item,
ui-accordion table.LC_nested tr.LC_even_row td.LC_right_item {
  text-align: left;
  width: 60%;
  padding: 2px 4px;
}

table.LC_nested tr.LC_odd_row td {
  background-color: #EEEEEE;
}

table.LC_createuser {
}

table.LC_createuser tr.LC_section_row td {
  font-size: small;
}

table.LC_createuser tr.LC_info_row td  {
  background-color: #CCCCCC;
  font-weight: bold;
  text-align: center;
}

table.LC_calendar {
  border: 1px solid #000000;
  border-collapse: collapse;
  width: 98%;
}

table.LC_calendar_pickdate {
  font-size: xx-small;
}

table.LC_calendar tr td {
  border: 1px solid #000000;
  vertical-align: top;
  width: 14%;
}

table.LC_calendar tr td.LC_calendar_day_empty {
  background-color: $data_table_dark;
}

table.LC_calendar tr td.LC_calendar_day_current {
  background-color: $data_table_highlight;
}

table.LC_data_table tr td.LC_mail_new {
  background-color: $mail_new;
}

table.LC_data_table tr.LC_mail_new:hover {
  background-color: $mail_new_hover;
}

table.LC_data_table tr td.LC_mail_read {
  background-color: $mail_read;
}

/*
table.LC_data_table tr.LC_mail_read:hover {
  background-color: $mail_read_hover;
}
*/

table.LC_data_table tr td.LC_mail_replied {
  background-color: $mail_replied;
}

/*
table.LC_data_table tr.LC_mail_replied:hover {
  background-color: $mail_replied_hover;
}
*/

table.LC_data_table tr td.LC_mail_other {
  background-color: $mail_other;
}

/*
table.LC_data_table tr.LC_mail_other:hover {
  background-color: $mail_other_hover;
}
*/

table.LC_data_table tr > td.LC_browser_file,
table.LC_data_table tr > td.LC_browser_file_published {
  background: #AAEE77;
}

table.LC_data_table tr > td.LC_browser_file_locked,
table.LC_data_table tr > td.LC_browser_file_unpublished {
  background: #FFAA99;
}

table.LC_data_table tr > td.LC_browser_file_obsolete {
  background: #888888;
}

table.LC_data_table tr > td.LC_browser_file_modified,
table.LC_data_table tr > td.LC_browser_file_metamodified {
  background: #F8F866;
}

table.LC_data_table tr.LC_browser_folder > td {
  background: #E0E8FF;
}

table.LC_data_table tr > td.LC_roles_is {
  /* background: #77FF77; */
}

table.LC_data_table tr > td.LC_roles_future {
  border-right: 8px solid #FFFF77;
}

table.LC_data_table tr > td.LC_roles_will {
  border-right: 8px solid #FFAA77;
}

table.LC_data_table tr > td.LC_roles_expired {
  border-right: 8px solid #FF7777;
}

table.LC_data_table tr > td.LC_roles_will_not {
  border-right: 8px solid #AAFF77;
}

table.LC_data_table tr > td.LC_roles_selected {
  border-right: 8px solid #11CC55;
}

div.LC_roles_details {
  margin: 0;
}

span.LC_current_location {
  font-size:larger;
  background: $pgbg;
}

span.LC_parm_menu_item {
  font-size: larger;
}

span.LC_parm_scope_all {
  color: red;
}

span.LC_parm_scope_folder {
  color: green;
}

span.LC_parm_scope_resource {
  color: orange;
}

span.LC_parm_part {
  color: blue;
}

span.LC_parm_folder,
span.LC_parm_symb {
  font-size: x-small;
  font-family: $mono;
  color: #AAAAAA;
}

ul.LC_parm_parmlist li {
  display: inline-block;
  padding: 0.3em 0.8em;
  vertical-align: top;
  width: 150px;
  border-top:1px solid $lg_border_color;
}

td.LC_parm_overview_level_menu,
td.LC_parm_overview_map_menu,
td.LC_parm_overview_parm_selectors,
td.LC_parm_overview_restrictions  {
  border: 1px solid black;
  border-collapse: collapse;
}

table.LC_parm_overview_restrictions td {
  border-width: 1px 4px 1px 4px;
  border-style: solid;
  border-color: $pgbg;
  text-align: center;
}

table.LC_parm_overview_restrictions th {
  background: $tabbg;
  border-width: 1px 4px 1px 4px;
  border-style: solid;
  border-color: $pgbg;
}

table#LC_helpmenu {
  border: none;
  height: 55px;
  border-spacing: 0;
}

table#LC_helpmenu fieldset legend {
  font-size: larger;
}

table#LC_helpmenu_links {
  width: 100%;
  border: 1px solid black;
  background: $pgbg;
  padding: 0;
  border-spacing: 1px;
}

table#LC_helpmenu_links tr td {
  padding: 1px;
  background: $tabbg;
  text-align: center;
  font-weight: bold;
}

table#LC_helpmenu_links a:link,
table#LC_helpmenu_links a:visited,
table#LC_helpmenu_links a:active {
  text-decoration: none;
  color: $font;
}

table#LC_helpmenu_links a:hover {
  text-decoration: underline;
  color: $vlink;
}

LC_chrt_popup_exists {
  border: 1px solid #339933;
  margin: -1px;
}

LC_chrt_popup_up {
  border: 1px solid yellow;
  margin: -1px;
}

LC_chrt_popup {
  border: 1px solid #8888FF;
  background: #CCCCFF;
}

table.LC_pick_box {
  border-collapse: separate;
  background: white;
  border: 1px solid black;
  border-spacing: 1px;
}

table.LC_pick_box td.LC_pick_box_title {
  background: $sidebg;
  font-weight: bold;
  text-align: left;
  vertical-align: top;
  width: 184px;
  padding: 8px;
}

table.LC_pick_box td.LC_pick_box_value {
  text-align: left;
  padding: 8px;
}

table.LC_pick_box td.LC_pick_box_select {
  text-align: left;
  padding: 8px;
}

table.LC_pick_box td.LC_pick_box_separator {
  padding: 0;
  height: 1px;
  background: black;
}

table.LC_pick_box td.LC_pick_box_submit {
  text-align: right;
}

table.LC_pick_box td.LC_evenrow_value {
  text-align: left;
  padding: 8px;
  background-color: $data_table_light;
}

table.LC_pick_box td.LC_oddrow_value {
  text-align: left;
  padding: 8px;
  background-color: $data_table_light;
}

span.LC_helpform_receipt_cat {
  font-weight: bold;
}

table.LC_group_priv_box {
  background: white;
  border: 1px solid black;
  border-spacing: 1px;
}

table.LC_group_priv_box td.LC_pick_box_title {
  background: $tabbg;
  font-weight: bold;
  text-align: right;
  width: 184px;
}

table.LC_group_priv_box td.LC_groups_fixed {
  background: $data_table_light;
  text-align: center;
}

table.LC_group_priv_box td.LC_groups_optional {
  background: $data_table_dark;
  text-align: center;
}

table.LC_group_priv_box td.LC_groups_functionality {
  background: $data_table_darker;
  text-align: center;
  font-weight: bold;
}

table.LC_group_priv td {
  text-align: left;
  padding: 0;
}

LC_navbuttons {
  margin: 2ex 0ex 2ex 0ex;
}

LC_topic_bar {
  font-weight: bold;
  background: $tabbg;
  margin: 1em 0em 1em 2em;
  padding: 3px;
  font-size: 1.2em;
}

LC_topic_bar span {
  left: 0.5em;
  position: absolute;
  vertical-align: middle;
  font-size: 1.2em;
}

table.LC_course_group_status {
  margin: 20px;
}

table.LC_status_selector td {
  vertical-align: top;
  text-align: center;
  padding: 4px;
}

div.LC_feedback_link {
  clear: both;
  background: $sidebg;
  width: 100%;
  padding-bottom: 10px;
  border: 1px $tabbg solid;
  height: 22px;
  line-height: 22px;
  padding-top: 5px;
}

div.LC_feedback_link img {
  height: 22px;
  vertical-align:middle;
}

div.LC_feedback_link a {
  text-decoration: none;
}

div.LC_comblock {
  display:inline;
  color:$font;
  font-size:90%;
}

div.LC_feedback_link div.LC_comblock {
  padding-left:5px;
}

div.LC_feedback_link div.LC_comblock a {
  color:$font;
}

span.LC_feedback_link {
  /* background: $feedback_link_bg; */
  font-size: larger;
}

span.LC_message_link {
  /* background: $feedback_link_bg; */
  font-size: larger;
  position: absolute;
  right: 1em;
}

table.LC_prior_tries {
  border: 1px solid #000000;
  border-collapse: separate;
  border-spacing: 1px;
}

table.LC_prior_tries td {
  padding: 2px;
}

LC_answer_correct {
  background: lightgreen;
  color: darkgreen;
  padding: 6px;
}

LC_answer_charged_try {
  background: #FFAAAA;
  color: darkred;
  padding: 6px;
}

LC_answer_not_charged_try,
LC_answer_no_grade,
LC_answer_late {
  background: lightyellow;
  color: black;
  padding: 6px;
}

LC_answer_previous {
  background: lightblue;
  color: darkblue;
  padding: 6px;
}

LC_answer_no_message {
  background: #FFFFFF;
  color: black;
  padding: 6px;
}

LC_answer_unknown {
  background: orange;
  color: black;
  padding: 6px;
}

span.LC_prior_numerical,
span.LC_prior_string,
span.LC_prior_custom,
span.LC_prior_reaction,
span.LC_prior_math {
  font-family: $mono;
  white-space: pre;
}

span.LC_prior_string {
  font-family: $mono;
  white-space: pre;
}

table.LC_prior_option {
  width: 100%;
  border-collapse: collapse;
}

table.LC_prior_rank,
table.LC_prior_match {
  border-collapse: collapse;
}

table.LC_prior_option tr td,
table.LC_prior_rank tr td,
table.LC_prior_match tr td {
  border: 1px solid #000000;
}

LC_nobreak {
  white-space: nowrap;
}

span.LC_cusr_emph {
  font-style: italic;
}

span.LC_cusr_subheading {
  font-weight: normal;
  font-size: 85%;
}

div.LC_docs_entry_move {
  border: 1px solid #BBBBBB;
  background: #DDDDDD;
  width: 22px;
  padding: 1px;
  margin: 0;
}

table.LC_data_table tr > td.LC_docs_entry_commands,
table.LC_data_table tr > td.LC_docs_entry_parameter {
  background: #DDDDDD;
  font-size: x-small;
}

LC_docs_entry_parameter {
  white-space: nowrap;
}

LC_docs_copy {
  color: #000099;
}

LC_docs_cut {
  color: #550044;
}

LC_docs_rename {
  color: #009900;
}

LC_docs_remove {
  color: #990000;
}

LC_docs_reinit_warn,
LC_docs_ext_edit {
  font-size: x-small;
}

table.LC_docs_adddocs td,
table.LC_docs_adddocs th {
  border: 1px solid #BBBBBB;
  padding: 4px;
  background: #DDDDDD;
}

table.LC_sty_begin {
  background: #BBFFBB;
}

table.LC_sty_end {
  background: #FFBBBB;
}

table.LC_double_column {
  border-width: 0;
  border-collapse: collapse;
  width: 100%;
  padding: 2px;
}

table.LC_double_column tr td.LC_left_col {
  top: 2px;
  left: 2px;
  width: 47%;
  vertical-align: top;
}

table.LC_double_column tr td.LC_right_col {
  top: 2px;
  right: 2px;
  width: 47%;
  vertical-align: top;
}

div.LC_left_float {
  float: left;
  padding-right: 5%;
  padding-bottom: 4px;
}

div.LC_clear_float_header {
  padding-bottom: 2px;
}

div.LC_clear_float_footer {
  padding-top: 10px;
  clear: both;
}

div.LC_grade_show_user {
/*  border-left: 5px solid $sidebg; */
  border-top: 5px solid #000000;
  margin: 50px 0 0 0;
  padding: 15px 0 5px 10px;
}

div.LC_grade_show_user_odd_row {
/*  border-left: 5px solid #000000; */
}

div.LC_grade_show_user div.LC_Box {
  margin-right: 50px;
}

div.LC_grade_submissions,
div.LC_grade_message_center,
div.LC_grade_info_links {
  margin: 5px;
  width: 99%;
  background: #FFFFFF;
}

div.LC_grade_submissions_header,
div.LC_grade_message_center_header {
  font-weight: bold;
  font-size: large;
}

div.LC_grade_submissions_body,
div.LC_grade_message_center_body {
  border: 1px solid black;
  width: 99%;
  background: #FFFFFF;
}

table.LC_scantron_action {
  width: 100%;
}

table.LC_scantron_action tr th {
  font-weight:bold;
  font-style:normal;
}

LC_edit_problem_header,
div.LC_edit_problem_footer {
  font-weight: normal;
  font-size:  medium;
  margin: 2px;
}

div.LC_edit_problem_header,
div.LC_edit_problem_header div,
div.LC_edit_problem_footer,
div.LC_edit_problem_footer div,
div.LC_edit_problem_editxml_header,
div.LC_edit_problem_editxml_header div {
  margin-top: 5px;
}

div.LC_edit_problem_header_title {
  font-weight: bold;
  font-size: larger;
  background: $tabbg;
  padding: 3px;
}

table.LC_edit_problem_header_title {
  width: 100%;
  background: $tabbg;
}

div.LC_edit_problem_discards {
  float: left;
  padding-bottom: 5px;
}

div.LC_edit_problem_saves {
  float: right;
  padding-bottom: 5px;
}

img.stift {
  border-width: 0;
  vertical-align: middle;
}

table td.LC_mainmenu_col_fieldset {
  vertical-align: top;
}

div.LC_createcourse {
  margin: 10px 10px 10px 10px;
}

LC_dccid {
  margin: 0.2em 0 0 0;
  padding: 0;
  font-size: 90%;
  display:none;
}

a:hover,
ol.LC_primary_menu a:hover,
ol#LC_MenuBreadcrumbs a:hover,
ol#LC_PathBreadcrumbs a:hover,
ul#LC_secondary_menu a:hover,
LC_FormSectionClearButton input:hover
ul.LC_TabContent   li:hover a {
  color:$button_hover;
  text-decoration:none;
}

h1 {
  padding: 0;
  line-height:130%;
}

h2,
h3,
h4,
h5,
h6 {
  margin: 5px 0 5px 0;
  padding: 0;
  line-height:130%;
}

LC_hcell {
  padding:3px 15px 3px 15px;
  margin: 0;
  background-color:$tabbg;
  color:$fontmenu;
  border-bottom:solid 1px $lg_border_color;
}

LC_Box > .LC_hcell {
  margin: 0 -10px 10px -10px;
}

LC_noBorder {
  border: 0;
}

LC_FormSectionClearButton input {
  background-color:transparent;
  border: none;
  cursor:pointer;
  text-decoration:underline;
}

LC_help_open_topic {
  color: #FFFFFF;
  background-color: #EEEEFF;
  margin: 1px;
  padding: 4px;
  border: 1px solid #000033;
  white-space: nowrap;
  /* vertical-align: middle; */
}

dl,
ul,
div,
fieldset {
  margin: 10px 10px 10px 0;
  /* overflow: hidden; */
}

fieldset > legend {
  font-weight: bold;
  padding: 0 5px 0 5px;
}

#LC_nav_bar {
  float: left;
  margin: 0 0 2px 0;
}

#LC_realm {
  margin: 0.2em 0 0 0;
  padding: 0;
  font-weight: bold;
  text-align: center;
}

#LC_nav_bar em {
  font-weight: bold;
  font-style: normal;
}

ol.LC_primary_menu {
  float: right;
  margin: 0;
}

ol#LC_PathBreadcrumbs {
  margin: 0;
}

ol.LC_primary_menu li {
  display: inline;
  padding: 5px 5px 0 10px;
  vertical-align: top;
}

ol.LC_primary_menu li img {
  vertical-align: bottom;
  height: 1.1em;
}

ol.LC_primary_menu a {
  color: RGB(80, 80, 80);
  text-decoration: none;
}

ol.LC_primary_menu a.LC_new_message {
  font-weight:bold;
  color: darkred;
}

ol.LC_docs_parameters {
  margin-left: 0;
  padding: 0;
  list-style: none;
}

ol.LC_docs_parameters li {
  margin: 0;
  padding-right: 20px;
  display: inline;
}

ol.LC_docs_parameters li:before {
  content: "\\002022 \\0020";
}

li.LC_docs_parameters_title {
  font-weight: bold;
}

ol.LC_docs_parameters li.LC_docs_parameters_title:before {
  content: "";
}

ul#LC_secondary_menu {
  clear: both;
  color: $fontmenu;
  background: $tabbg;
  list-style: none;
  padding: 0;
  margin: 0;
  width: 100%;
}

ul#LC_secondary_menu li {
  font-weight: bold;
  line-height: 1.8em;
  padding: 0 0.8em;
  border-right: 1px solid black;
  display: inline;
  vertical-align: middle;
}

ul.LC_TabContent {
  display:block;
  background: $sidebg;
  border-bottom: solid 1px $lg_border_color;
  list-style:none;
  margin: 0 -10px;
  padding: 0;
}

ul.LC_TabContent li,
ul.LC_TabContentBigger li {
  float:left;
}

ul#LC_secondary_menu li a {
  color: $fontmenu;
  text-decoration: none;
}

ul.LC_TabContent {
  min-height:20px;
}

ul.LC_TabContent li {
  vertical-align:middle;
  padding: 0 16px 0 10px;
  background-color:$tabbg;
  border-bottom:solid 1px $lg_border_color;
  border-right: solid 1px $font;
}

ul.LC_TabContent .right {
  float:right;
}

ul.LC_TabContent li a,
ul.LC_TabContent li {
  color:rgb(47,47,47);
  text-decoration:none;
  font-size:95%;
  font-weight:bold;
  min-height:20px;
}

ul.LC_TabContent li a:hover,
ul.LC_TabContent li a:focus {
  color: $button_hover;
  background:none;
  outline:none;
}

ul.LC_TabContent li:hover {
  color: $button_hover;
  cursor:pointer;
}

ul.LC_TabContent li.active {
  color: $font;
  background:#FFFFFF url(/adm/lonIcons/open.gif) no-repeat scroll right center;
  border-bottom:solid 1px #FFFFFF;
  cursor: default;
}

ul.LC_TabContent li.active a {
  color:$font;
  background:#FFFFFF;
  outline: none;
}
#maincoursedoc {
  clear:both;
}

ul.LC_TabContentBigger {
  display:block;
  list-style:none;
  padding: 0;
}

ul.LC_TabContentBigger li {
  vertical-align:bottom;
  height: 30px;
  font-size:110%;
  font-weight:bold;
  color: #737373;
}

ul.LC_TabContentBigger li.active {
  position: relative;
  top: 1px;
}

ul.LC_TabContentBigger li a {
  background:url('/adm/lonIcons/tabbgleft.gif') left bottom no-repeat;
  height: 30px;
  line-height: 30px;
  text-align: center;
  display: block;
  text-decoration: none;
  outline: none;  
}

ul.LC_TabContentBigger li.active a {
  background:url('/adm/lonIcons/tabbgleft.gif') left top no-repeat;
  color:$font;
}

ul.LC_TabContentBigger li b {
  background: url('/adm/lonIcons/tabbgright.gif') no-repeat right bottom;
  display: block;
  float: left;
  padding: 0 30px;
  border-bottom: 1px solid $lg_border_color;
}

ul.LC_TabContentBigger li:hover b {
  color:$button_hover;
}

ul.LC_TabContentBigger li.active b {
  background:url('/adm/lonIcons/tabbgright.gif') right top no-repeat;
  color:$font;
  border: 0;
  cursor:default;
}


ul.LC_CourseBreadcrumbs {
  background: $sidebg;
  line-height: 32px;
  padding-left: 10px;
  margin: 0 0 10px 0;
  list-style-position: inside;

}

ol#LC_MenuBreadcrumbs,
ol#LC_PathBreadcrumbs {
  padding-left: 10px;
  margin: 0;
  height: 2.5em;  /* equal to #LC_breadcrumbs line-height */
}

ol#LC_MenuBreadcrumbs li,
ol#LC_PathBreadcrumbs li,
ul.LC_CourseBreadcrumbs li {
  display: inline;
  white-space: normal;  
}

ol#LC_MenuBreadcrumbs li a,
ul.LC_CourseBreadcrumbs li a {
  text-decoration: none;
  font-size:90%;
}

ol#LC_MenuBreadcrumbs h1 {
  display: inline;
  font-size: 90%;
  line-height: 2.5em;
  margin: 0;
  padding: 0;
}

ol#LC_PathBreadcrumbs li a {
  text-decoration:none;
  font-size:100%;
  font-weight:bold;
}

LC_Box {
  border: solid 1px $lg_border_color;
  padding: 0 10px 10px 10px;
}

LC_AboutMe_Image {
  float:left;
  margin-right:10px;
}

LC_Clear_AboutMe_Image {
  clear:left;
}

dl.LC_ListStyleClean dt {
  padding-right: 5px;
  display: table-header-group;
}

dl.LC_ListStyleClean dd {
  display: table-row;
}

LC_ListStyleClean,
LC_ListStyleSimple,
LC_ListStyleNormal,
LC_ListStyleSpecial {
  /* display:block; */
  list-style-position: inside;
  list-style-type: none;
  overflow: hidden;
  padding: 0;
}

LC_ListStyleSimple li,
LC_ListStyleSimple dd,
LC_ListStyleNormal li,
LC_ListStyleNormal dd,
LC_ListStyleSpecial li,
LC_ListStyleSpecial dd {
  margin: 0;
  padding: 5px 5px 5px 10px;
  clear: both;
}

LC_ListStyleClean li,
LC_ListStyleClean dd {
  padding-top: 0;
  padding-bottom: 0;
}

LC_ListStyleSimple dd,
LC_ListStyleSimple li {
  border-bottom: solid 1px $lg_border_color;
}

LC_ListStyleSpecial li,
LC_ListStyleSpecial dd {
  list-style-type: none;
  background-color: RGB(220, 220, 220);
  margin-bottom: 4px;
}

table.LC_SimpleTable {
  margin:5px;
  border:solid 1px $lg_border_color;
}

table.LC_SimpleTable tr {
  padding: 0;
  border:solid 1px $lg_border_color;
}

table.LC_SimpleTable thead {
  background:rgb(220,220,220);
}

div.LC_columnSection {
  display: block;
  clear: both;
  overflow: hidden;
  margin: 0;
}

div.LC_columnSection>* {
  float: left;
  margin: 10px 20px 10px 0;
  overflow:hidden;
}

table em {
  font-weight: bold;
  font-style: normal;
}

table.LC_tableBrowseRes,
table.LC_tableOfContent {
  border:none;
  border-spacing: 1px;
  padding: 3px;
  background-color: #FFFFFF;
  font-size: 90%;
}

table.LC_tableOfContent {
  border-collapse: collapse;
}

table.LC_tableBrowseRes a,
table.LC_tableOfContent a {
  background-color: transparent;
  text-decoration: none;
}

table.LC_tableOfContent img {
  border: none;
  height: 1.3em;
  vertical-align: text-bottom;
  margin-right: 0.3em;
}

a#LC_content_toolbar_firsthomework {
  background-image:url(/res/adm/pages/open-first-problem.gif);
}

a#LC_content_toolbar_everything {
  background-image:url(/res/adm/pages/show-all.gif);
}

a#LC_content_toolbar_uncompleted {
  background-image:url(/res/adm/pages/show-incomplete-problems.gif);
}

#LC_content_toolbar_clearbubbles {
  background-image:url(/res/adm/pages/mark-discussionentries-read.gif);
}

a#LC_content_toolbar_changefolder {
  background : url(/res/adm/pages/close-all-folders.gif) top center ;
}

a#LC_content_toolbar_changefolder_toggled {
  background-image:url(/res/adm/pages/open-all-folders.gif);
}

ul#LC_toolbar li a:hover {
  background-position: bottom center;
}

ul#LC_toolbar {
  padding: 0;
  margin: 2px;
  list-style:none;
  position:relative;
  background-color:white;
}

ul#LC_toolbar li {
  border:1px solid white;
  padding: 0;
  margin: 0;
  float: left;
  display:inline;
  vertical-align:middle;
}


a.LC_toolbarItem {
  display:block;
  padding: 0;
  margin: 0;
  height: 32px;
  width: 32px;
  color:white;
  border: none;
  background-repeat:no-repeat;
  background-color:transparent;
}

ul.LC_funclist {
    margin: 0;
    padding: 0.5em 1em 0.5em 0;
}

ul.LC_funclist > li:first-child {
    font-weight:bold; 
    margin-left:0.8em;
}

ul.LC_funclist + ul.LC_funclist {
    /* 
       left border as a seperator if we have more than
       one list 
    */
    border-left: 1px solid $sidebg;
    /* 
       this hides the left border behind the border of the 
       outer box if element is wrapped to the next 'line' 
    */
    margin-left: -1px;
}

ul.LC_funclist li {
  display: inline;
  white-space: nowrap;
  margin: 0 0 0 25px;
  line-height: 150%;
}

ui-accordion .LC_advanced_toggle {
  float: right;
  font-size: 90%;
  padding: 0px 4px
}

LC_hidden {
  display: none;
}

END
}

=pod

=item * &headtag()

Returns a uniform footer for LON-CAPA web pages.

Inputs: $title - optional title for the head
        $head_extra - optional extra HTML to put inside the <head>
        $args - optional arguments
            force_register - if is true call registerurl so the remote is 
                             informed
            redirect       -> array ref of
                                   1- seconds before redirect occurs
                                   2- url to redirect to
                                   3- whether the side effect should occur
                           (side effect of setting 
                               $env{'internal.head.redirect'} to the url 
                               redirected too)
            domain         -> force to color decorate a page for a specific
                               domain
            function       -> force usage of a specific rolish color scheme
            bgcolor        -> override the default page bgcolor
            no_auto_mt_title
                           -> prevent &mt()ing the title arg

=cut

sub headtag {
    my ($title,$head_extra,$args) = @_;
    
    my $function = $args->{'function'} || &get_users_function();
    my $domain   = $args->{'domain'}   || &determinedomain();
    my $bgcolor  = $args->{'bgcolor'}  || &designparm($function.'.pgbg',$domain);
    my $url = join(':',$env{'user.name'},$env{'user.domain'},
		   $Apache::lonnet::perlvar{'lonVersion'},
		   #time(),
		   $env{'environment.color.timestamp'},
		   $function,$domain,$bgcolor);

    $url = '/adm/css/'.&escape($url).'.css';

    my $result =
	'<head>'.
	&font_settings();

    if (!$args->{'frameset'}) {
	$result .= &Apache::lonhtmlcommon::htmlareaheaders();
    }
    if ($args->{'force_register'} && $env{'request.noversionuri'} !~ m{^/res/adm/pages/}) {
        $result .= Apache::lonxml::display_title();
    }
    if (!$args->{'no_nav_bar'} 
	&& !$args->{'only_body'}
	&& !$args->{'frameset'}) {
	$result .= &help_menu_js();
    }

    if (ref($args->{'redirect'})) {
	my ($time,$url,$inhibit_continue) = @{$args->{'redirect'}};
	$url = &Apache::lonenc::check_encrypt($url);
	if (!$inhibit_continue) {
	    $env{'internal.head.redirect'} = $url;
	}
	$result.=<<ADDMETA
<meta http-equiv="pragma" content="no-cache" />
<meta http-equiv="Refresh" content="$time; url=$url" />
ADDMETA
    }
    if (!defined($title)) {
	$title = 'The LearningOnline Network with CAPA';
    }
    if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
    $result .= '<title> LON-CAPA '.$title.'</title>'
	.'<link rel="stylesheet" type="text/css" href="'.$url.'" />'
	.$head_extra;
    return $result.'</head>';
}

=pod

=item * &font_settings()

Returns neccessary <meta> to set the proper encoding

Inputs: none

=cut

sub font_settings {
    my $headerstring='';
    if (!$env{'browser.mathml'} && $env{'browser.unicode'}) {
	$headerstring.=
	    '<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />';
    }
    return $headerstring;
}

=pod

=item * &xml_begin()

Returns the needed doctype and <html>

Inputs: none

=cut

sub xml_begin {
    my $output='';

    if ($env{'browser.mathml'}) {
	$output='<?xml version="1.0"?>'
            #.'<?xml-stylesheet type="text/css" href="/adm/MathML/mathml.css"?>'."\n"
#            .'<!DOCTYPE html SYSTEM "/adm/MathML/mathml.dtd" '
            
#	    .'<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd" [<!ENTITY mathns "http://www.w3.org/1998/Math/MathML">] >'
	    .'<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1 plus MathML 2.0 plus SVG 1.1//EN" "http://www.w3.org/2002/04/xhtml-math-svg/xhtml-math-svg.dtd">'
            .'<html xmlns:math="http://www.w3.org/1998/Math/MathML" ' 
	    .'xmlns="http://www.w3.org/1999/xhtml">';
    } else {
	$output='<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">'
           .'<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">';
    }
    return $output;
}

=pod

=item * &start_page()

Returns a complete <html> .. <body> section for LON-CAPA web pages.

Inputs:

=over 4

$title - optional title for the page

$head_extra - optional extra HTML to incude inside the <head>

$args - additional optional args supported are:

=over 8

             only_body      -> is true will set &bodytag() onlybodytag
                                    arg on
             no_nav_bar     -> is true will set &bodytag() no_nav_bar arg on
             add_entries    -> additional attributes to add to the  <body>
             domain         -> force to color decorate a page for a 
                                    specific domain
             function       -> force usage of a specific rolish color
                                    scheme
             redirect       -> see &headtag()
             bgcolor        -> override the default page bg color
             js_ready       -> return a string ready for being used in 
                                    a javascript writeln
             html_encode    -> return a string ready for being used in 
                                    a html attribute
             force_register -> if is true will turn on the &bodytag()
                                    $forcereg arg
             frameset       -> if true will start with a <frameset>
                                    rather than <body>
             skip_phases    -> hash ref of 
                                    head -> skip the <html><head> generation
                                    body -> skip all <body> generation
             no_auto_mt_title -> prevent &mt()ing the title arg
             inherit_jsmath -> when creating popup window in a page,
                                    should it have jsmath forced on by the
                                    current page
             bread_crumbs ->             Array containing breadcrumbs
             bread_crumbs_component ->  if exists show it as headline else show only the breadcrumbs

=back

=back

=cut

sub start_page {
    my ($title,$head_extra,$args) = @_;
    #&Apache::lonnet::logthis("start_page ".join(':',caller(0)));
#SD
#I don't see why we copy certain elements of %$args to %head_args
#head args is passed to headtag() and this routine only reads those
#keys that are needed. There doesn't happen any writes or any processing
#of other keys.
#proposal: just pass $args to headtag instead of \%head_args and delete 
#marked lines
#<- MARK
    my %head_args;
    foreach my $arg ('redirect','force_register','domain','function',
		     'bgcolor','frameset','no_nav_bar','only_body',
		     'no_auto_mt_title') {
	if (defined($args->{$arg})) {
	    $head_args{$arg} = $args->{$arg};
	}
    }
#MARK ->

    $env{'internal.start_page'}++;
    my $result;

    if (! exists($args->{'skip_phases'}{'head'}) ) {
        $result .= 
                  &xml_begin() . &headtag($title,$head_extra,\%head_args);
#replace prev line by
#                 &xml_begin() . &headtag($title, $head_extra, $args);
    }
    
    if (! exists($args->{'skip_phases'}{'body'}) ) {
	if ($args->{'frameset'}) {
	    my $attr_string = &make_attr_string($args->{'force_register'},
						$args->{'add_entries'});
	    $result .= "\n<frameset $attr_string>\n";
        } else {
            $result .=
                &bodytag($title, 
                         $args->{'function'},       $args->{'add_entries'},
                         $args->{'only_body'},      $args->{'domain'},
                         $args->{'force_register'}, $args->{'no_nav_bar'},
                         $args->{'bgcolor'},        $args);
        }
    }

    if ($args->{'js_ready'}) {
		$result = &js_ready($result);
    }
    if ($args->{'html_encode'}) {
		$result = &html_encode($result);
    }

    # Preparation for new and consistent functionlist at top of screen
    # if ($args->{'functionlist'}) {
    #            $result .= &build_functionlist();
    #}

    # Don't add anything more if only_body wanted or in const space
    return $result if    $args->{'only_body'} 
                      || $env{'request.state'} eq 'construct';

    #Breadcrumbs
    if (exists($args->{'bread_crumbs'}) or exists($args->{'bread_crumbs_component'})) {
		&Apache::lonhtmlcommon::clear_breadcrumbs();
		#if any br links exists, add them to the breadcrumbs
		if (exists($args->{'bread_crumbs'}) and ref($args->{'bread_crumbs'}) eq 'ARRAY') {         
			foreach my $crumb (@{$args->{'bread_crumbs'}}){
				&Apache::lonhtmlcommon::add_breadcrumb($crumb);
			}
		}

		#if bread_crumbs_component exists show it as headline else show only the breadcrumbs
		if(exists($args->{'bread_crumbs_component'})){
			$result .= &Apache::lonhtmlcommon::breadcrumbs($args->{'bread_crumbs_component'});
		}else{
			$result .= &Apache::lonhtmlcommon::breadcrumbs();
		}
    }
    return $result;
}

sub end_page {
    my ($args) = @_;
    $env{'internal.end_page'}++;
    my $result;
    if ($args->{'discussion'}) {
	my ($target,$parser);
	if (ref($args->{'discussion'})) {
	    ($target,$parser) =($args->{'discussion'}{'target'},
				$args->{'discussion'}{'parser'});
	}
	$result .= &Apache::lonxml::xmlend($target,$parser);
    }

    if ($args->{'frameset'}) {
	$result .= '</frameset>';
    } else {
	$result .= &endbodytag($args);
    }
    $result .= "\n</html>";

    if ($args->{'js_ready'}) {
	$result = &js_ready($result);
    }

    if ($args->{'html_encode'}) {
	$result = &html_encode($result);
    }

    return $result;
}

sub html_encode {
    my ($result) = @_;

    $result = &HTML::Entities::encode($result,'<>&"');
    
    return $result;
}
sub js_ready {
    my ($result) = @_;

    $result =~ s/[\n\r]/ /xmsg;
    $result =~ s/\\/\\\\/xmsg;
    $result =~ s/'/\\'/xmsg;
    $result =~ s{</}{<\\/}xmsg;
    
    return $result;
}

sub validate_page {
    if (  exists($env{'internal.start_page'})
	  &&     $env{'internal.start_page'} > 1) {
	&Apache::lonnet::logthis('start_page called multiple times '.
				 $env{'internal.start_page'}.' '.
				 $ENV{'request.filename'});
    }
    if (  exists($env{'internal.end_page'})
	  &&     $env{'internal.end_page'} > 1) {
	&Apache::lonnet::logthis('end_page called multiple times '.
				 $env{'internal.end_page'}.' '.
				 $env{'request.filename'});
    }
    if (     exists($env{'internal.start_page'})
	&& ! exists($env{'internal.end_page'})) {
	&Apache::lonnet::logthis('start_page called without end_page '.
				 $env{'request.filename'});
    }
    if (   ! exists($env{'internal.start_page'})
	&&   exists($env{'internal.end_page'})) {
	&Apache::lonnet::logthis('end_page called without start_page'.
				 $env{'request.filename'});
    }
}

sub simple_error_page {
    my ($r,$title,$msg) = @_;
    my $page =
	&Apache::loncommon::start_page($title).
	&mt($msg).
	&Apache::loncommon::end_page();
    if (ref($r)) {
	$r->print($page);
	return;
    }
    return $page;
}

{
    my @row_count;

    sub start_data_table_count {
        unshift(@row_count, 0);
        return;
    }

    sub end_data_table_count {
        shift(@row_count);
        return;
    }

    sub start_data_table {
	my ($add_class) = @_;
	my $css_class = (join(' ','LC_data_table',$add_class));
	&start_data_table_count();
	return '<table class="'.$css_class.'">'."\n";
    }

    sub end_data_table {
	&end_data_table_count();
	return '</table>'."\n";;
    }

    sub start_data_table_row {
	my ($add_class, $id) = @_;
	$row_count[0]++;
	my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
	$css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
        $id = (' id="'.$id.'"') unless ($id eq '');
        return  '<tr class="'.$css_class.'"'.$id.'>'."\n";
    }
    
    sub continue_data_table_row {
	my ($add_class, $id) = @_;
	my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
	$css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
        $id = (' id="'.$id.'"') unless ($id eq '');
        return  '<tr class="'.$css_class.'"'.$id.'>'."\n";
    }

    sub end_data_table_row {
	return '</tr>'."\n";;
    }

    sub start_data_table_empty_row {
#	$row_count[0]++;
	return  '<tr class="LC_empty_row" >'."\n";;
    }

    sub end_data_table_empty_row {
	return '</tr>'."\n";;
    }

    sub start_data_table_header_row {
	return  '<tr class="LC_header_row">'."\n";;
    }

    sub end_data_table_header_row {
	return '</tr>'."\n";;
    }

    sub data_table_caption {
        my $caption = shift;
        return "<caption class=\"LC_caption\">$caption</caption>";
    }
}

=pod

=item * &inhibit_menu_check($arg)

Checks for a inhibitmenu state and generates output to preserve it

Inputs:         $arg - can be any of
                     - undef - in which case the return value is a string 
                               to add  into arguments list of a uri
                     - 'input' - in which case the return value is a HTML
                                 <form> <input> field of type hidden to
                                 preserve the value
                     - a url - in which case the return value is the url with
                               the neccesary cgi args added to preserve the
                               inhibitmenu state
                     - a ref to a url - no return value, but the string is
                                        updated to include the neccessary cgi
                                        args to preserve the inhibitmenu state

=cut

sub inhibit_menu_check {
    my ($arg) = @_;
    &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
    if ($arg eq 'input') {
	if ($env{'form.inhibitmenu'}) {
	    return '<input type="hidden" name="inhibitmenu" value="'.$env{'form.inhibitmenu'}.'" />';
	} else {
	    return
	}
    }
    if ($env{'form.inhibitmenu'}) {
	if (ref($arg)) {
	    $$arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
	} elsif ($arg eq '') {
	    $arg .= 'inhibitmenu='.$env{'form.inhibitmenu'};
	} else {
	    $arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
	}
    }
    if (!ref($arg)) {
	return $arg;
    }
}

###############################################

=pod

=back

=head1 User Information Routines

=over 4

=item * &get_users_function()

Used by &bodytag to determine the current users primary role.
Returns either 'student','coordinator','admin', or 'author'.

=cut

###############################################
sub get_users_function {
    my $function = 'norole';
    if ($env{'request.role'}=~/^(st)/) {
        $function='student';
    }
    if ($env{'request.role'}=~/^(cc|co|in|ta|ep)/) {
        $function='coordinator';
    }
    if ($env{'request.role'}=~/^(su|dc|ad|li)/) {
        $function='admin';
    }
    if (($env{'request.role'}=~/^(au|ca|aa)/) ||
        ($ENV{'REQUEST_URI'}=~/^(\/priv|\~)/)) {
        $function='author';
    }
    return $function;
}

###############################################

=pod

=item * &show_course()

Used by lonmenu.pm and lonroles.pm to determine whether to use the word
'Courses' or 'Roles' in inline navigation and on screen displaying user's roles.

Inputs:
None

Outputs:
Scalar: 1 if 'Course' to be used, 0 otherwise.

=cut

###############################################
sub show_course {
    my $course = !$env{'user.adv'};
    if (!$env{'user.adv'}) {
        foreach my $env (keys(%env)) {
            next if ($env !~ m/^user\.priv\./);
            if ($env !~ m/^user\.priv\.(?:st|cm)/) {
                $course = 0;
                last;
            }
        }
    }
    return $course;
}

###############################################

=pod

=item * &check_user_status()

Determines current status of supplied role for a
specific user. Roles can be active, previous or future.

Inputs: 
user's domain, user's username, course's domain,
course's number, optional section ID.

Outputs:
role status: active, previous or future. 

=cut

sub check_user_status {
    my ($udom,$uname,$cdom,$crs,$role,$sec) = @_;
    my $extra = &Apache::lonnet::freeze_escape({'skipcheck' => 1});
    my %userinfo = &Apache::lonnet::dump('roles',$udom,$uname,'.',undef,$extra);
    my @uroles = keys %userinfo;
    my $srchstr;
    my $active_chk = 'none';
    my $now = time;
    if (@uroles > 0) {
        if (($role eq 'cc') || ($role eq 'co') || ($sec eq '') || (!defined($sec))) {
            $srchstr = '/'.$cdom.'/'.$crs.'_'.$role;
        } else {
            $srchstr = '/'.$cdom.'/'.$crs.'/'.$sec.'_'.$role;
        }
        if (grep/^\Q$srchstr\E$/,@uroles) {
            my $role_end = 0;
            my $role_start = 0;
            $active_chk = 'active';
            if ($userinfo{$srchstr} =~ m/^\Q$role\E_(\d+)/) {
                $role_end = $1;
                if ($userinfo{$srchstr} =~ m/^\Q$role\E_\Q$role_end\E_(\d+)$/) {
                    $role_start = $1;
                }
            }
            if ($role_start > 0) {
                if ($now < $role_start) {
                    $active_chk = 'future';
                }
            }
            if ($role_end > 0) {
                if ($now > $role_end) {
                    $active_chk = 'previous';
                }
            }
        }
    }
    return $active_chk;
}

###############################################

=pod

=item * &get_sections()

Determines all the sections for a course including
sections with students and sections containing other roles.
Incoming parameters: 

1. domain
2. course number 
3. reference to array containing roles for which sections should 
be gathered (optional).
4. reference to array containing status types for which sections 
should be gathered (optional).

If the third argument is undefined, sections are gathered for any role. 
If the fourth argument is undefined, sections are gathered for any status.
Permissible values are 'active' or 'future' or 'previous'.
 
Returns section hash (keys are section IDs, values are
number of users in each section), subject to the
optional roles filter, optional status filter 

=cut

###############################################
sub get_sections {
    my ($cdom,$cnum,$possible_roles,$possible_status) = @_;
    if (!defined($cdom) || !defined($cnum)) {
        my $cid =  $env{'request.course.id'};

	return if (!defined($cid));

        $cdom = $env{'course.'.$cid.'.domain'};
        $cnum = $env{'course.'.$cid.'.num'};
    }

    my %sectioncount;
    my $now = time;

    if (!defined($possible_roles) || (grep(/^st$/,@$possible_roles))) {
	my ($classlist) = &Apache::loncoursedata::get_classlist($cdom,$cnum);
	my $sec_index = &Apache::loncoursedata::CL_SECTION();
	my $status_index = &Apache::loncoursedata::CL_STATUS();
        my $start_index = &Apache::loncoursedata::CL_START();
        my $end_index = &Apache::loncoursedata::CL_END();
        my $status;
	while (my ($student,$data) = each(%$classlist)) {
	    my ($section,$stu_status,$start,$end) = ($data->[$sec_index],
				                     $data->[$status_index],
                                                     $data->[$start_index],
                                                     $data->[$end_index]);
            if ($stu_status eq 'Active') {
                $status = 'active';
            } elsif ($end < $now) {
                $status = 'previous';
            } elsif ($start > $now) {
                $status = 'future';
            } 
	    if ($section ne '-1' && $section !~ /^\s*$/) {
                if ((!defined($possible_status)) || (($status ne '') && 
                    (grep/^\Q$status\E$/,@{$possible_status}))) { 
		    $sectioncount{$section}++;
                }
	    }
	}
    }
    my %courseroles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
    foreach my $user (sort(keys(%courseroles))) {
	if ($user !~ /^(\w{2})/) { next; }
	my ($role) = ($user =~ /^(\w{2})/);
	if ($possible_roles && !(grep(/^$role$/,@$possible_roles))) { next; }
	my ($section,$status);
	if ($role eq 'cr' &&
	    $user =~ m-^$role/[^/]*/[^/]*/[^/]*:[^:]*:[^:]*:(\w+)-) {
	    $section=$1;
	}
	if ($user =~ /^$role:[^:]*:[^:]*:(\w+)/) { $section=$1; }
	if (!defined($section) || $section eq '-1') { next; }
        my ($end,$start) = ($courseroles{$user} =~ /^([^:]*):([^:]*)$/);
        if ($end == -1 && $start == -1) {
            next; #deleted role
        }
        if (!defined($possible_status)) { 
            $sectioncount{$section}++;
        } else {
            if ((!$end || $end >= $now) && (!$start || $start <= $now)) {
                $status = 'active';
            } elsif ($end < $now) {
                $status = 'future';
            } elsif ($start > $now) {
                $status = 'previous';
            }
            if (($status ne '') && (grep/^\Q$status\E$/,@{$possible_status})) {
                $sectioncount{$section}++;
            }
        }
    }
    return %sectioncount;
}

###############################################

=pod

=item * &get_course_users()

Retrieves usernames:domains for users in the specified course
with specific role(s), and access status. 

Incoming parameters:
1. course domain
2. course number
3. access status: users must have - either active, 
previous, future, or all.
4. reference to array of permissible roles
5. reference to array of section restrictions (optional)
6. reference to results object (hash of hashes).
7. reference to optional userdata hash
8. reference to optional statushash
9. flag if privileged users (except those set to unhide in
   course settings) should be excluded    
Keys of top level results hash are roles.
Keys of inner hashes are username:domain, with 
values set to access type.
Optional userdata hash returns an array with arguments in the 
same order as loncoursedata::get_classlist() for student data.

Optional statushash returns

Entries for end, start, section and status are blank because
of the possibility of multiple values for non-student roles.

=cut

###############################################

sub get_course_users {
    my ($cdom,$cnum,$types,$roles,$sections,$users,$userdata,$statushash,$hidepriv) = @_;
    my %idx = ();
    my %seclists;

    $idx{udom} = &Apache::loncoursedata::CL_SDOM();
    $idx{uname} =  &Apache::loncoursedata::CL_SNAME();
    $idx{end} = &Apache::loncoursedata::CL_END();
    $idx{start} = &Apache::loncoursedata::CL_START();
    $idx{id} = &Apache::loncoursedata::CL_ID();
    $idx{section} = &Apache::loncoursedata::CL_SECTION();
    $idx{fullname} = &Apache::loncoursedata::CL_FULLNAME();
    $idx{status} = &Apache::loncoursedata::CL_STATUS();

    if (grep(/^st$/,@{$roles})) {
        my ($classlist,$keylist)=&Apache::loncoursedata::get_classlist($cdom,$cnum);
        my $now = time;
        foreach my $student (keys(%{$classlist})) {
            my $match = 0;
            my $secmatch = 0;
            my $section = $$classlist{$student}[$idx{section}];
            my $status = $$classlist{$student}[$idx{status}];
            if ($section eq '') {
                $section = 'none';
            }
            if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
                if (grep(/^all$/,@{$sections})) {
                    $secmatch = 1;
                } elsif ($$classlist{$student}[$idx{section}] eq '') {
                    if (grep(/^none$/,@{$sections})) {
                        $secmatch = 1;
                    }
                } else {  
		    if (grep(/^\Q$section\E$/,@{$sections})) {
		        $secmatch = 1;
                    }
		}
                if (!$secmatch) {
                    next;
                }
            }
            if (defined($$types{'active'})) {
                if ($$classlist{$student}[$idx{status}] eq 'Active') {
                    push(@{$$users{st}{$student}},'active');
                    $match = 1;
                }
            }
            if (defined($$types{'previous'})) {
                if ($$classlist{$student}[$idx{status}] eq 'Expired') {
                    push(@{$$users{st}{$student}},'previous');
                    $match = 1;
                }
            }
            if (defined($$types{'future'})) {
                if ($$classlist{$student}[$idx{status}] eq 'Future') {
                    push(@{$$users{st}{$student}},'future');
                    $match = 1;
                }
            }
            if ($match) {
                push(@{$seclists{$student}},$section);
                if (ref($userdata) eq 'HASH') {
                    $$userdata{$student} = $$classlist{$student};
                }
                if (ref($statushash) eq 'HASH') {
                    $statushash->{$student}{'st'}{$section} = $status;
                }
            }
        }
    }
    if ((@{$roles} > 1) || ((@{$roles} == 1) && ($$roles[0] ne "st"))) {
        my %coursepersonnel = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
        my $now = time;
        my %displaystatus = ( previous => 'Expired',
                              active   => 'Active',
                              future   => 'Future',
                            );
        my %nothide;
        if ($hidepriv) {
            my %coursehash=&Apache::lonnet::coursedescription($cdom.'_'.$cnum);
            foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
                if ($user !~ /:/) {
                    $nothide{join(':',split(/[\@]/,$user))}=1;
                } else {
                    $nothide{$user} = 1;
                }
            }
        }
        foreach my $person (sort(keys(%coursepersonnel))) {
            my $match = 0;
            my $secmatch = 0;
            my $status;
            my ($role,$user,$usec) = ($person =~ /^([^:]*):([^:]+:[^:]+):([^:]*)/);
            $user =~ s/:$//;
            my ($end,$start) = split(/:/,$coursepersonnel{$person});
            if ($end == -1 || $start == -1) {
                next;
            }
            if (($role) && ((grep(/^\Q$role\E$/,@{$roles})) ||
                (grep(/^cr$/,@{$roles}) && $role =~ /^cr\//))) {
                my ($uname,$udom) = split(/:/,$user);
                if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
                    if (grep(/^all$/,@{$sections})) {
                        $secmatch = 1;
                    } elsif ($usec eq '') {
                        if (grep(/^none$/,@{$sections})) {
                            $secmatch = 1;
                        }
                    } else {
                        if (grep(/^\Q$usec\E$/,@{$sections})) {
                            $secmatch = 1;
                        }
                    }
                    if (!$secmatch) {
                        next;
                    }
                }
                if ($usec eq '') {
                    $usec = 'none';
                }
                if ($uname ne '' && $udom ne '') {
                    if ($hidepriv) {
                        if ((&Apache::lonnet::privileged($uname,$udom)) &&
                            (!$nothide{$uname.':'.$udom})) {
                            next;
                        }
                    }
                    if ($end > 0 && $end < $now) {
                        $status = 'previous';
                    } elsif ($start > $now) {
                        $status = 'future';
                    } else {
                        $status = 'active';
                    }
                    foreach my $type (keys(%{$types})) { 
                        if ($status eq $type) {
                            if (!grep(/^\Q$type\E$/,@{$$users{$role}{$user}})) {
                                push(@{$$users{$role}{$user}},$type);
                            }
                            $match = 1;
                        }
                    }
                    if (($match) && (ref($userdata) eq 'HASH')) {
                        if (!exists($$userdata{$uname.':'.$udom})) {
			    &get_user_info($udom,$uname,\%idx,$userdata);
                        }
                        if (!grep(/^\Q$usec\E$/,@{$seclists{$uname.':'.$udom}})) {
                            push(@{$seclists{$uname.':'.$udom}},$usec);
                        }
                        if (ref($statushash) eq 'HASH') {
                            $statushash->{$uname.':'.$udom}{$role}{$usec} = $displaystatus{$status};
                        }
                    }
                }
            }
        }
        if (grep(/^ow$/,@{$roles})) {
            if ((defined($cdom)) && (defined($cnum))) {
                my %csettings = &Apache::lonnet::get('environment',['internal.courseowner'],$cdom,$cnum);
                if ( defined($csettings{'internal.courseowner'}) ) {
                    my $owner = $csettings{'internal.courseowner'};
                    next if ($owner eq '');
                    my ($ownername,$ownerdom);
                    if ($owner =~ /^([^:]+):([^:]+)$/) {
                        $ownername = $1;
                        $ownerdom = $2;
                    } else {
                        $ownername = $owner;
                        $ownerdom = $cdom;
                        $owner = $ownername.':'.$ownerdom;
                    }
                    @{$$users{'ow'}{$owner}} = 'any';
                    if (defined($userdata) && 
			!exists($$userdata{$owner})) {
			&get_user_info($ownerdom,$ownername,\%idx,$userdata);
                        if (!grep(/^none$/,@{$seclists{$owner}})) {
                            push(@{$seclists{$owner}},'none');
                        }
                        if (ref($statushash) eq 'HASH') {
                            $statushash->{$owner}{'ow'}{'none'} = 'Any';
                        }
		    }
                }
            }
        }
        foreach my $user (keys(%seclists)) {
            @{$seclists{$user}} = (sort {$a <=> $b} @{$seclists{$user}});
            $$userdata{$user}[$idx{section}] = join(',',@{$seclists{$user}});
        }
    }
    return;
}

sub get_user_info {
    my ($udom,$uname,$idx,$userdata) = @_;
    $$userdata{$uname.':'.$udom}[$$idx{fullname}] = 
	&plainname($uname,$udom,'lastname');
    $$userdata{$uname.':'.$udom}[$$idx{uname}] = $uname;
    $$userdata{$uname.':'.$udom}[$$idx{udom}] = $udom;
    my %idhash =  &Apache::lonnet::idrget($udom,($uname));
    $$userdata{$uname.':'.$udom}[$$idx{id}] = $idhash{$uname}; 
    return;
}

###############################################

=pod

=item * &get_user_quota()

Retrieves quota assigned for storage of portfolio files for a user  

Incoming parameters:
1. user's username
2. user's domain

Returns:
1. Disk quota (in Mb) assigned to student.
2. (Optional) Type of setting: custom or default
   (individually assigned or default for user's 
   institutional status).
3. (Optional) - User's institutional status (e.g., faculty, staff
   or student - types as defined in localenroll::inst_usertypes 
   for user's domain, which determines default quota for user.
4. (Optional) - Default quota which would apply to the user.

If a value has been stored in the user's environment, 
it will return that, otherwise it returns the maximal default
defined for the user's instituional status(es) in the domain.

=cut

###############################################


sub get_user_quota {
    my ($uname,$udom) = @_;
    my ($quota,$quotatype,$settingstatus,$defquota);
    if (!defined($udom)) {
        $udom = $env{'user.domain'};
    }
    if (!defined($uname)) {
        $uname = $env{'user.name'};
    }
    if (($udom eq '' || $uname eq '') ||
        ($udom eq 'public') && ($uname eq 'public')) {
        $quota = 0;
        $quotatype = 'default';
        $defquota = 0; 
    } else {
        my $inststatus;
        if ($udom eq $env{'user.domain'} && $uname eq $env{'user.name'}) {
            $quota = $env{'environment.portfolioquota'};
            $inststatus = $env{'environment.inststatus'};
        } else {
            my %userenv = 
                &Apache::lonnet::get('environment',['portfolioquota',
                                     'inststatus'],$udom,$uname);
            my ($tmp) = keys(%userenv);
            if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
                $quota = $userenv{'portfolioquota'};
                $inststatus = $userenv{'inststatus'};
            } else {
                undef(%userenv);
            }
        }
        ($defquota,$settingstatus) = &default_quota($udom,$inststatus);
        if ($quota eq '') {
            $quota = $defquota;
            $quotatype = 'default';
        } else {
            $quotatype = 'custom';
        }
    }
    if (wantarray) {
        return ($quota,$quotatype,$settingstatus,$defquota);
    } else {
        return $quota;
    }
}

###############################################

=pod

=item * &default_quota()

Retrieves default quota assigned for storage of user portfolio files,
given an (optional) user's institutional status.

Incoming parameters:
1. domain
2. (Optional) institutional status(es).  This is a : separated list of 
   status types (e.g., faculty, staff, student etc.)
   which apply to the user for whom the default is being retrieved.
   If the institutional status string in undefined, the domain
   default quota will be returned. 

Returns:
1. Default disk quota (in Mb) for user portfolios in the domain.
2. (Optional) institutional type which determined the value of the
   default quota.

If a value has been stored in the domain's configuration db,
it will return that, otherwise it returns 20 (for backwards 
compatibility with domains which have not set up a configuration
db file; the original statically defined portfolio quota was 20 Mb). 

If the user's status includes multiple types (e.g., staff and student),
the largest default quota which applies to the user determines the
default quota returned.

=back

=cut

###############################################


sub default_quota {
    my ($udom,$inststatus) = @_;
    my ($defquota,$settingstatus);
    my %quotahash = &Apache::lonnet::get_dom('configuration',
                                            ['quotas'],$udom);
    if (ref($quotahash{'quotas'}) eq 'HASH') {
        if ($inststatus ne '') {
            my @statuses = map { &unescape($_); } split(/:/,$inststatus);
            foreach my $item (@statuses) {
                if (ref($quotahash{'quotas'}{'defaultquota'}) eq 'HASH') {
                    if ($quotahash{'quotas'}{'defaultquota'}{$item} ne '') {
                        if ($defquota eq '') {
                            $defquota = $quotahash{'quotas'}{'defaultquota'}{$item};
                            $settingstatus = $item;
                        } elsif ($quotahash{'quotas'}{'defaultquota'}{$item} > $defquota) {
                            $defquota = $quotahash{'quotas'}{'defaultquota'}{$item};
                            $settingstatus = $item;
                        }
                    }
                } else {
                    if ($quotahash{'quotas'}{$item} ne '') {
                        if ($defquota eq '') {
                            $defquota = $quotahash{'quotas'}{$item};
                            $settingstatus = $item;
                        } elsif ($quotahash{'quotas'}{$item} > $defquota) {
                            $defquota = $quotahash{'quotas'}{$item};
                            $settingstatus = $item;
                        }
                    }
                }
            }
        }
        if ($defquota eq '') {
            if (ref($quotahash{'quotas'}{'defaultquota'}) eq 'HASH') {
                $defquota = $quotahash{'quotas'}{'defaultquota'}{'default'};
            } else {
                $defquota = $quotahash{'quotas'}{'default'};
            }
            $settingstatus = 'default';
        }
    } else {
        $settingstatus = 'default';
        $defquota = 20;
    }
    if (wantarray) {
        return ($defquota,$settingstatus);
    } else {
        return $defquota;
    }
}

sub get_secgrprole_info {
    my ($cdom,$cnum,$needroles,$type)  = @_;
    my %sections_count = &get_sections($cdom,$cnum);
    my @sections =  (sort {$a <=> $b} keys(%sections_count));
    my %curr_groups = &Apache::longroup::coursegroups($cdom,$cnum);
    my @groups = sort(keys(%curr_groups));
    my $allroles = [];
    my $rolehash;
    my $accesshash = {
                     active => 'Currently has access',
                     future => 'Will have future access',
                     previous => 'Previously had access',
                  };
    if ($needroles) {
        $rolehash = {'all' => 'all'};
        my %user_roles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
	if (&Apache::lonnet::error(%user_roles)) {
	    undef(%user_roles);
	}
        foreach my $item (keys(%user_roles)) {
            my ($role)=split(/\:/,$item,2);
            if ($role eq 'cr') { next; }
            if ($role =~ /^cr/) {
                $$rolehash{$role} = (split('/',$role))[3];
            } else {
                $$rolehash{$role} = &Apache::lonnet::plaintext($role,$type);
            }
        }
        foreach my $key (sort(keys(%{$rolehash}))) {
            push(@{$allroles},$key);
        }
        push (@{$allroles},'st');
        $$rolehash{'st'} = &Apache::lonnet::plaintext('st',$type);
    }
    return (\@sections,\@groups,$allroles,$rolehash,$accesshash);
}

sub user_picker {
    my ($dom,$srch,$forcenewuser,$caller,$cancreate,$usertype) = @_;
    my $currdom = $dom;
    my %curr_selected = (
                        srchin => 'dom',
                        srchby => 'lastname',
                      );
    my $srchterm;
    if ((ref($srch) eq 'HASH') && ($env{'form.origform'} ne 'crtusername')) {
        if ($srch->{'srchby'} ne '') {
            $curr_selected{'srchby'} = $srch->{'srchby'};
        }
        if ($srch->{'srchin'} ne '') {
            $curr_selected{'srchin'} = $srch->{'srchin'};
        }
        if ($srch->{'srchtype'} ne '') {
            $curr_selected{'srchtype'} = $srch->{'srchtype'};
        }
        if ($srch->{'srchdomain'} ne '') {
            $currdom = $srch->{'srchdomain'};
        }
        $srchterm = $srch->{'srchterm'};
    }
    my %lt=&Apache::lonlocal::texthash(
                    'usr'       => 'Search criteria',
                    'doma'      => 'Domain/institution to search',
                    'uname'     => 'username',
                    'lastname'  => 'last name',
                    'lastfirst' => 'last name, first name',
                    'crs'       => 'in this course',
                    'dom'       => 'in selected LON-CAPA domain', 
                    'alc'       => 'all LON-CAPA',
                    'instd'     => 'in institutional directory for selected domain',
                    'exact'     => 'is',
                    'contains'  => 'contains',
                    'begins'    => 'begins with',
                    'youm'      => "You must include some text to search for.",
                    'thte'      => "The text you are searching for must contain at least two characters when using a 'begins' type search.",
                    'thet'      => "The text you are searching for must contain at least three characters when using a 'contains' type search.",
                    'yomc'      => "You must choose a domain when using an institutional directory search.",
                    'ymcd'      => "You must choose a domain when using a domain search.",
                    'whus'      => "When using searching by last,first you must include a comma as separator between last name and first name.",
                    'whse'      => "When searching by last,first you must include at least one character in the first name.",
                     'thfo'     => "The following need to be corrected before the search can be run:",
                                       );
    my $domform = &select_dom_form($currdom,'srchdomain',1,1);
    my $srchinsel = ' <select name="srchin">';

    my @srchins = ('crs','dom','alc','instd');

    foreach my $option (@srchins) {
        # FIXME 'alc' option unavailable until 
        #       loncreateuser::print_user_query_page()
        #       has been completed.
        next if ($option eq 'alc');
        next if (($option eq 'crs') && ($env{'form.form'} eq 'requestcrs'));  
        next if ($option eq 'crs' && !$env{'request.course.id'});
        if ($curr_selected{'srchin'} eq $option) {
            $srchinsel .= ' 
   <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
        } else {
            $srchinsel .= '
   <option value="'.$option.'">'.$lt{$option}.'</option>';
        }
    }
    $srchinsel .= "\n  </select>\n";

    my $srchbysel =  ' <select name="srchby">';
    foreach my $option ('lastname','lastfirst','uname') {
        if ($curr_selected{'srchby'} eq $option) {
            $srchbysel .= '
   <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
        } else {
            $srchbysel .= '
   <option value="'.$option.'">'.$lt{$option}.'</option>';
         }
    }
    $srchbysel .= "\n  </select>\n";

    my $srchtypesel = ' <select name="srchtype">';
    foreach my $option ('begins','contains','exact') {
        if ($curr_selected{'srchtype'} eq $option) {
            $srchtypesel .= '
   <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
        } else {
            $srchtypesel .= '
   <option value="'.$option.'">'.$lt{$option}.'</option>';
        }
    }
    $srchtypesel .= "\n  </select>\n";

    my ($newuserscript,$new_user_create);

    if ($forcenewuser) {
        if (ref($srch) eq 'HASH') {
            if ($srch->{'srchby'} eq 'uname' && $srch->{'srchtype'} eq 'exact' && $srch->{'srchin'} eq 'dom' && $srch->{'srchdomain'} eq $env{'request.role.domain'}) {
                if ($cancreate) {
                    $new_user_create = '<p> <input type="submit" name="forcenew" value="'.&HTML::Entities::encode(&mt('Make new user "[_1]"',$srchterm),'<>&"').'" onclick="javascript:setSearch(\'1\','.$caller.');" /> </p>';
                } else {
                    my $helplink = 'javascript:helpMenu('."'display'".')';
                    my %usertypetext = (
                        official   => 'institutional',
                        unofficial => 'non-institutional',
                    );
                    $new_user_create = '<p class="LC_warning">'
                                      .&mt("You are not authorized to create new $usertypetext{$usertype} users in this domain.")
                                      .' '
                                      .&mt('Please contact the [_1]helpdesk[_2] for assistance.'
                                          ,'<a href="'.$helplink.'">','</a>')
                                      .'</p><br />';
                }
            }
        }

        $newuserscript = <<"ENDSCRIPT";

function setSearch(createnew,callingForm) {
    if (createnew == 1) {
        for (var i=0; i<callingForm.srchby.length; i++) {
            if (callingForm.srchby.options[i].value == 'uname') {
                callingForm.srchby.selectedIndex = i;
            }
        }
        for (var i=0; i<callingForm.srchin.length; i++) {
            if ( callingForm.srchin.options[i].value == 'dom') {
		callingForm.srchin.selectedIndex = i;
            }
        }
        for (var i=0; i<callingForm.srchtype.length; i++) {
            if (callingForm.srchtype.options[i].value == 'exact') {
                callingForm.srchtype.selectedIndex = i;
            }
        }
        for (var i=0; i<callingForm.srchdomain.length; i++) {
            if (callingForm.srchdomain.options[i].value == '$env{'request.role.domain'}') {
                callingForm.srchdomain.selectedIndex = i;
            }
        }
    }
}
ENDSCRIPT

    }

    my $output = <<"END_BLOCK";
<script type="text/javascript">
// <![CDATA[
function validateEntry(callingForm) {

    var checkok = 1;
    var srchin;
    for (var i=0; i<callingForm.srchin.length; i++) {
	if ( callingForm.srchin[i].checked ) {
	    srchin = callingForm.srchin[i].value;
	}
    }

    var srchtype = callingForm.srchtype.options[callingForm.srchtype.selectedIndex].value;
    var srchby = callingForm.srchby.options[callingForm.srchby.selectedIndex].value;
    var srchdomain = callingForm.srchdomain.options[callingForm.srchdomain.selectedIndex].value;
    var srchterm =  callingForm.srchterm.value;
    var srchin = callingForm.srchin.options[callingForm.srchin.selectedIndex].value;
    var msg = "";

    if (srchterm == "") {
        checkok = 0;
        msg += "$lt{'youm'}\\n";
    }

    if (srchtype== 'begins') {
        if (srchterm.length < 2) {
            checkok = 0;
            msg += "$lt{'thte'}\\n";
        }
    }

    if (srchtype== 'contains') {
        if (srchterm.length < 3) {
            checkok = 0;
            msg += "$lt{'thet'}\\n";
        }
    }
    if (srchin == 'instd') {
        if (srchdomain == '') {
            checkok = 0;
            msg += "$lt{'yomc'}\\n";
        }
    }
    if (srchin == 'dom') {
        if (srchdomain == '') {
            checkok = 0;
            msg += "$lt{'ymcd'}\\n";
        }
    }
    if (srchby == 'lastfirst') {
        if (srchterm.indexOf(",") == -1) {
            checkok = 0;
            msg += "$lt{'whus'}\\n";
        }
        if (srchterm.indexOf(",") == srchterm.length -1) {
            checkok = 0;
            msg += "$lt{'whse'}\\n";
        }
    }
    if (checkok == 0) {
        alert("$lt{'thfo'}\\n"+msg);
        return;
    }
    if (checkok == 1) {
        callingForm.submit();
    }
}

$newuserscript

// ]]>
</script>

$new_user_create

END_BLOCK

    $output .= &Apache::lonhtmlcommon::start_pick_box().
               &Apache::lonhtmlcommon::row_title($lt{'doma'}).
               $domform.
               &Apache::lonhtmlcommon::row_closure().
               &Apache::lonhtmlcommon::row_title($lt{'usr'}).
               $srchbysel.
               $srchtypesel. 
               '<input type="text" size="15" name="srchterm" value="'.$srchterm.'" />'.
               $srchinsel.
               &Apache::lonhtmlcommon::row_closure(1). 
               &Apache::lonhtmlcommon::end_pick_box().
               '<br />';
    return $output;
}

sub user_rule_check {
    my ($usershash,$checks,$alerts,$rulematch,$inst_results,$curr_rules,$got_rules) = @_;
    my $response;
    if (ref($usershash) eq 'HASH') {
        foreach my $user (keys(%{$usershash})) {
            my ($uname,$udom) = split(/:/,$user);
            next if ($udom eq '' || $uname eq '');
            my ($id,$newuser);
            if (ref($usershash->{$user}) eq 'HASH') {
                $newuser = $usershash->{$user}->{'newuser'};
                $id = $usershash->{$user}->{'id'};
            }
            my $inst_response;
            if (ref($checks) eq 'HASH') {
                if (defined($checks->{'username'})) {
                    ($inst_response,%{$inst_results->{$user}}) = 
                        &Apache::lonnet::get_instuser($udom,$uname);
                } elsif (defined($checks->{'id'})) {
                    ($inst_response,%{$inst_results->{$user}}) =
                        &Apache::lonnet::get_instuser($udom,undef,$id);
                }
            } else {
                ($inst_response,%{$inst_results->{$user}}) =
                    &Apache::lonnet::get_instuser($udom,$uname);
                return;
            }
            if (!$got_rules->{$udom}) {
                my %domconfig = &Apache::lonnet::get_dom('configuration',
                                                  ['usercreation'],$udom);
                if (ref($domconfig{'usercreation'}) eq 'HASH') {
                    foreach my $item ('username','id') {
                        if (ref($domconfig{'usercreation'}{$item.'_rule'}) eq 'ARRAY') {
                            $$curr_rules{$udom}{$item} = 
                                $domconfig{'usercreation'}{$item.'_rule'};
                        }
                    }
                }
                $got_rules->{$udom} = 1;  
            }
            foreach my $item (keys(%{$checks})) {
                if (ref($$curr_rules{$udom}) eq 'HASH') {
                    if (ref($$curr_rules{$udom}{$item}) eq 'ARRAY') {
                        if (@{$$curr_rules{$udom}{$item}} > 0) {
                            my %rule_check = &Apache::lonnet::inst_rulecheck($udom,$uname,$id,$item,$$curr_rules{$udom}{$item});
                            foreach my $rule (@{$$curr_rules{$udom}{$item}}) {
                                if ($rule_check{$rule}) {
                                    $$rulematch{$user}{$item} = $rule;
                                    if ($inst_response eq 'ok') {
                                        if (ref($inst_results) eq 'HASH') {
                                            if (ref($inst_results->{$user}) eq 'HASH') {
                                                if (keys(%{$inst_results->{$user}}) == 0) {
                                                    $$alerts{$item}{$udom}{$uname} = 1;
                                                }
                                            }
                                        }
                                    }
                                    last;
                                }
                            }
                        }
                    }
                }
            }
        }
    }
    return;
}

sub user_rule_formats {
    my ($domain,$domdesc,$curr_rules,$check) = @_;
    my %text = ( 
                 'username' => 'Usernames',
                 'id'       => 'IDs',
               );
    my $output;
    my ($rules,$ruleorder) = &Apache::lonnet::inst_userrules($domain,$check);
    if ((ref($rules) eq 'HASH') && (ref($ruleorder) eq 'ARRAY')) {
        if (@{$ruleorder} > 0) {
            $output = '<br />'.&mt("$text{$check} with the following format(s) may <span class=\"LC_cusr_emph\">only</span> be used for verified users at [_1]:",$domdesc).' <ul>';
            foreach my $rule (@{$ruleorder}) {
                if (ref($curr_rules) eq 'ARRAY') {
                    if (grep(/^\Q$rule\E$/,@{$curr_rules})) {
                        if (ref($rules->{$rule}) eq 'HASH') {
                            $output .= '<li>'.$rules->{$rule}{'name'}.': '.
                                        $rules->{$rule}{'desc'}.'</li>';
                        }
                    }
                }
            }
            $output .= '</ul>';
        }
    }
    return $output;
}

sub instrule_disallow_msg {
    my ($checkitem,$domdesc,$count,$mode) = @_;
    my $response;
    my %text = (
                  item   => 'username',
                  items  => 'usernames',
                  match  => 'matches',
                  do     => 'does',
                  action => 'a username',
                  one    => 'one',
               );
    if ($count > 1) {
        $text{'item'} = 'usernames';
        $text{'match'} ='match';
        $text{'do'} = 'do';
        $text{'action'} = 'usernames',
        $text{'one'} = 'ones';
    }
    if ($checkitem eq 'id') {
        $text{'items'} = 'IDs';
        $text{'item'} = 'ID';
        $text{'action'} = 'an ID';
        if ($count > 1) {
            $text{'item'} = 'IDs';
            $text{'action'} = 'IDs';
        }
    }
    $response = &mt("The $text{'item'} you chose $text{'match'} the format of $text{'items'} defined for [_1], but the $text{'item'} $text{'do'} not exist in the institutional directory.",'<span class="LC_cusr_emph">'.$domdesc.'</span>').'<br />';
    if ($mode eq 'upload') {
        if ($checkitem eq 'username') {
            $response .= &mt("You will need to modify your upload file so it will include $text{'action'} with a different format --  $text{'one'} that will not conflict with 'official' institutional $text{'items'}.");
        } elsif ($checkitem eq 'id') {
            $response .= &mt("Either upload a file which includes $text{'action'} with a different format --  $text{'one'} that will not conflict with 'official' institutional $text{'items'}, or when associating fields with data columns, omit an association for the Student/Employee ID field.");
        }
    } elsif ($mode eq 'selfcreate') {
        if ($checkitem eq 'id') {
            $response .= &mt("You must either choose $text{'action'} with a different format --  $text{'one'} that will not conflict with 'official' institutional $text{'items'}, or leave the ID field blank.");
        }
    } else {
        if ($checkitem eq 'username') {
            $response .= &mt("You must choose $text{'action'} with a different format --  $text{'one'} that will not conflict with 'official' institutional $text{'items'}.");
        } elsif ($checkitem eq 'id') {
            $response .= &mt("You must either choose $text{'action'} with a different format --  $text{'one'} that will not conflict with 'official' institutional $text{'items'}, or leave the ID field blank.");
        }
    }
    return $response;
}

sub personal_data_fieldtitles {
    my %fieldtitles = &Apache::lonlocal::texthash (
                        id => 'Student/Employee ID',
                        permanentemail => 'E-mail address',
                        lastname => 'Last Name',
                        firstname => 'First Name',
                        middlename => 'Middle Name',
                        generation => 'Generation',
                        gen => 'Generation',
                        inststatus => 'Affiliation',
                   );
    return %fieldtitles;
}

sub sorted_inst_types {
    my ($dom) = @_;
    my ($usertypes,$order) = &Apache::lonnet::retrieve_inst_usertypes($dom);
    my $othertitle = &mt('All users');
    if ($env{'request.course.id'}) {
        $othertitle  = &mt('Any users');
    }
    my @types;
    if (ref($order) eq 'ARRAY') {
        @types = @{$order};
    }
    if (@types == 0) {
        if (ref($usertypes) eq 'HASH') {
            @types = sort(keys(%{$usertypes}));
        }
    }
    if (keys(%{$usertypes}) > 0) {
        $othertitle = &mt('Other users');
    }
    return ($othertitle,$usertypes,\@types);
}

sub get_institutional_codes {
    my ($settings,$allcourses,$LC_code) = @_;
# Get complete list of course sections to update
    my @currsections = ();
    my @currxlists = ();
    my $coursecode = $$settings{'internal.coursecode'};

    if ($$settings{'internal.sectionnums'} ne '') {
        @currsections = split(/,/,$$settings{'internal.sectionnums'});
    }

    if ($$settings{'internal.crosslistings'} ne '') {
        @currxlists = split(/,/,$$settings{'internal.crosslistings'});
    }

    if (@currxlists > 0) {
        foreach (@currxlists) {
            if (m/^([^:]+):(\w*)$/) {
                unless (grep/^$1$/,@{$allcourses}) {
                    push @{$allcourses},$1;
                    $$LC_code{$1} = $2;
                }
            }
        }
    }
 
    if (@currsections > 0) {
        foreach (@currsections) {
            if (m/^(\w+):(\w*)$/) {
                my $sec = $coursecode.$1;
                my $lc_sec = $2;
                unless (grep/^$sec$/,@{$allcourses}) {
                    push @{$allcourses},$sec;
                    $$LC_code{$sec} = $lc_sec;
                }
            }
        }
    }
    return;
}

sub get_standard_codeitems {
    return ('Year','Semester','Department','Number','Section');
}

=pod

=head1 Slot Helpers

=over 4

=item * sorted_slots()

Sorts an array of slot names in order of slot start time (earliest first). 

Inputs:

=over 4

slotsarr  - Reference to array of unsorted slot names.

slots     - Reference to hash of hash, where outer hash keys are slot names.

=back

Returns:

=over 4

sorted   - An array of slot names sorted by the start time of the slot.

=back

=back

=cut


sub sorted_slots {
    my ($slotsarr,$slots) = @_;
    my @sorted;
    if ((ref($slotsarr) eq 'ARRAY') && (ref($slots) eq 'HASH')) {
        @sorted =
            sort {
                     if (ref($slots->{$a}) && ref($slots->{$b})) {
                         return $slots->{$a}{'starttime'} <=> $slots->{$b}{'starttime'}
                     }
                     if (ref($slots->{$a})) { return -1;}
                     if (ref($slots->{$b})) { return 1;}
                     return 0;
                 } @{$slotsarr};
    }
    return @sorted;
}


=pod

=head1 HTTP Helpers

=over 4

=item * &get_unprocessed_cgi($query,$possible_names)

Modify the %env hash to contain unprocessed CGI form parameters held in
$query.  The parameters listed in $possible_names (an array reference),
will be set in $env{'form.name'} if they do not already exist.

Typically called with $ENV{'QUERY_STRING'} as the first parameter.  
$possible_names is an ref to an array of form element names.  As an example:
get_unprocessed_cgi($ENV{'QUERY_STRING'},['uname','udom']);
will result in $env{'form.uname'} and $env{'form.udom'} being set.

=cut

sub get_unprocessed_cgi {
  my ($query,$possible_names)= @_;
  # $Apache::lonxml::debug=1;
  foreach my $pair (split(/&/,$query)) {
    my ($name, $value) = split(/=/,$pair);
    $name = &unescape($name);
    if (!defined($possible_names) || (grep {$_ eq $name} @$possible_names)) {
      $value =~ tr/+/ /;
      $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
      unless (defined($env{'form.'.$name})) { &add_to_env('form.'.$name,$value) };
    }
  }
}

=pod

=item * &cacheheader() 

returns cache-controlling header code

=cut

sub cacheheader {
    unless ($env{'request.method'} eq 'GET') { return ''; }
    my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime);
    my $output .='<meta HTTP-EQUIV="Expires" CONTENT="'.$date.'" />
                <meta HTTP-EQUIV="Cache-control" CONTENT="no-cache" />
                <meta HTTP-EQUIV="Pragma" CONTENT="no-cache" />';
    return $output;
}

=pod

=item * &no_cache($r) 

specifies header code to not have cache

=cut

sub no_cache {
    my ($r) = @_;
    if ($ENV{'REQUEST_METHOD'} ne 'GET' &&
	$env{'request.method'} ne 'GET') { return ''; }
    my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime(time));
    $r->no_cache(1);
    $r->header_out("Expires" => $date);
    $r->header_out("Pragma" => "no-cache");
}

sub content_type {
    my ($r,$type,$charset) = @_;
    if ($r) {
	#  Note that printout.pl calls this with undef for $r.
	&no_cache($r);
    }
    if ($env{'browser.mathml'} && $type eq 'text/html') { $type='text/xml'; }
    unless ($charset) {
	$charset=&Apache::lonlocal::current_encoding;
    }
    if ($charset) { $type.='; charset='.$charset; }
    if ($r) {
	$r->content_type($type);
    } else {
	print("Content-type: $type\n\n");
    }
}

=pod

=item * &add_to_env($name,$value) 

adds $name to the %env hash with value
$value, if $name already exists, the entry is converted to an array
reference and $value is added to the array.

=cut

sub add_to_env {
  my ($name,$value)=@_;
  if (defined($env{$name})) {
    if (ref($env{$name})) {
      #already have multiple values
      push(@{ $env{$name} },$value);
    } else {
      #first time seeing multiple values, convert hash entry to an arrayref
      my $first=$env{$name};
      undef($env{$name});
      push(@{ $env{$name} },$first,$value);
    }
  } else {
    $env{$name}=$value;
  }
}

=pod

=item * &get_env_multiple($name) 

gets $name from the %env hash, it seemlessly handles the cases where multiple
values may be defined and end up as an array ref.

returns an array of values

=cut

sub get_env_multiple {
    my ($name) = @_;
    my @values;
    if (defined($env{$name})) {
        # exists is it an array
        if (ref($env{$name})) {
            @values=@{ $env{$name} };
        } else {
            $values[0]=$env{$name};
        }
    }
    return(@values);
}

sub ask_for_embedded_content {
    my ($actionurl,$state,$allfiles,$codebase,$args)=@_;
    my (%subdependencies,%dependencies,%mapping,%existing,%newfiles,%pathchanges);
    my $num = 0;
    my $numremref = 0;
    my $numinvalid = 0;
    my $numpathchg = 0;
    my $numexisting = 0;
    my ($output,$upload_output,$toplevel,$url,$udom,$uname,$getpropath);
    if (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
        my $current_path='/';
        if ($env{'form.currentpath'}) {
            $current_path = $env{'form.currentpath'};
        }
        if ($actionurl eq '/adm/coursegrp_portfolio') {
            $udom = $env{'course.'.$env{'request.course.id'}.'.domain'};
            $uname = $env{'course.'.$env{'request.course.id'}.'.num'};
            $url = '/userfiles/groups/'.$env{'form.group'}.'/portfolio';
        } else {
            $udom = $env{'user.domain'};
            $uname = $env{'user.name'};
            $url = '/userfiles/portfolio';
        }
        $toplevel = $url.'/';
        $url .= $current_path;
        $getpropath = 1;
    } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank') ||
             ($actionurl eq '/adm/imsimport')) { 
        ($uname,my $rest) = ($args->{'current_path'} =~ m{/priv/($match_username)/?(.*)$});
        $url = '/home/'.$uname.'/public_html/';
        $toplevel = $url;
        if ($rest ne '') {
            $url .= $rest;
        }
    } elsif ($actionurl eq '/adm/coursedocs') {
        if (ref($args) eq 'HASH') {
           $url = $args->{'docs_url'};
           $toplevel = $url;
        }
    }
    my $now = time();
    foreach my $embed_file (keys(%{$allfiles})) {
        my $absolutepath;
        if ($embed_file =~ m{^\w+://}) {
            $newfiles{$embed_file} = 1;
            $mapping{$embed_file} = $embed_file;
        } else {
            if ($embed_file =~ m{^/}) {
                $absolutepath = $embed_file;
                $embed_file =~ s{^(/+)}{};
            }
            if ($embed_file =~ m{/}) {
                my ($path,$fname) = ($embed_file =~ m{^(.+)/([^/]*)$});
                $path = &check_for_traversal($path,$url,$toplevel);
                my $item = $fname;
                if ($path ne '') {
                    $item = $path.'/'.$fname;
                    $subdependencies{$path}{$fname} = 1;
                } else {
                    $dependencies{$item} = 1;
                }
                if ($absolutepath) {
                    $mapping{$item} = $absolutepath;
                } else {
                    $mapping{$item} = $embed_file;
                }
            } else {
                $dependencies{$embed_file} = 1;
                if ($absolutepath) {
                    $mapping{$embed_file} = $absolutepath;
                } else {
                    $mapping{$embed_file} = $embed_file;
                }
            }
        }
    }
    foreach my $path (keys(%subdependencies)) {
        my %currsubfile;
        if (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) { 
            my @subdir_list = &Apache::lonnet::dirlist($url.$path,$udom,$uname,$getpropath);
            foreach my $line (@subdir_list) {
                my ($file_name,$rest) = split(/\&/,$line,2);
                $currsubfile{$file_name} = 1;
            }
        } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
            if (opendir(my $dir,$url.'/'.$path)) {
                my @subdir_list = grep(!/^\./,readdir($dir));
                map {$currsubfile{$_} = 1;} @subdir_list;
            }
        }
        foreach my $file (keys(%{$subdependencies{$path}})) {
            if ($currsubfile{$file}) {
                my $item = $path.'/'.$file;
                unless ($mapping{$item} eq $item) {
                    $pathchanges{$item} = 1;
                }
                $existing{$item} = 1;
                $numexisting ++;
            } else {
                $newfiles{$path.'/'.$file} = 1;
            }
        }
    }
    my %currfile;
    if (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
        my @dir_list = &Apache::lonnet::dirlist($url,$udom,$uname,$getpropath);
        foreach my $line (@dir_list) {
            my ($file_name,$rest) = split(/\&/,$line,2);
            $currfile{$file_name} = 1;
        }
    } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
        if (opendir(my $dir,$url)) {
            my @dir_list = grep(!/^\./,readdir($dir));
            map {$currfile{$_} = 1;} @dir_list;
        }
    }
    foreach my $file (keys(%dependencies)) {
        if ($currfile{$file}) {
            unless ($mapping{$file} eq $file) {
                $pathchanges{$file} = 1;
            }
            $existing{$file} = 1;
            $numexisting ++;
        } else {
            $newfiles{$file} = 1;
        }
    }
    foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%newfiles)) {
        $upload_output .= &start_data_table_row().
                          '<td><span class="LC_filename">'.$embed_file.'</span>';
        unless ($mapping{$embed_file} eq $embed_file) {
            $upload_output .= '<br /><span class="LC_info" style="font-size:smaller;">'.&mt('changed from: [_1]',$mapping{$embed_file}).'</span>';
        }
        $upload_output .= '</td><td>';
        if ($args->{'ignore_remote_references'}
            && $embed_file =~ m{^\w+://}) {
            $upload_output.='<span class="LC_warning">'.&mt("URL points to other server.").'</span>';
            $numremref++;
        } elsif ($args->{'error_on_invalid_names'}
            && $embed_file ne &Apache::lonnet::clean_filename($embed_file,{'keep_path' => 1,})) {

            $upload_output.='<span class="LC_warning">'.&mt('Invalid characters').'</span>';
            $numinvalid++;
        } else {
            $upload_output .= &embedded_file_element('upload_embedded',$num,
                                                     $embed_file,\%mapping,
                                                     $allfiles,$codebase);
            $num++;
        }
        $upload_output .= '</td>'.&Apache::loncommon::end_data_table_row()."\n";
    }
    foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%existing)) {
        $upload_output .= &start_data_table_row().
                          '<td><span class="LC_filename">'.$embed_file.'</span></td>'.
                          '<td><span class="LC_warning">'.&mt('Already exists').'</span></td>'.
                          &Apache::loncommon::end_data_table_row()."\n";
    }
    if ($upload_output) {
        $upload_output = &start_data_table().
                         $upload_output.
                         &end_data_table()."\n";
    }
    my $applies = 0;
    if ($numremref) {
        $applies ++;
    }
    if ($numinvalid) {
        $applies ++;
    }
    if ($numexisting) {
        $applies ++;
    }
    if ($num) {
        $output = '<form name="upload_embedded" action="'.$actionurl.'"'.
                  ' method="post" enctype="multipart/form-data">'."\n".
                  $state.
                  '<h3>'.&mt('Upload embedded files').
                  ':</h3>'.$upload_output.'<br />'."\n".
                  '<input type ="hidden" name="number_embedded_items" value="'.
                  $num.'" />'."\n";
        if ($actionurl eq '') {
            $output .=  '<input type="hidden" name="phase" value="three" />';
        }
    } elsif ($applies) {
        $output = '<b>'.&mt('Referenced files').'</b>:<br />';
        if ($applies > 1) {
            $output .=  
                &mt('No files need to be uploaded, as one of the following applies to each reference:').'<ul>';
            if ($numremref) {
                $output .= '<li>'.&mt('reference is to a URL which points to another server').'</li>'."\n";
            }
            if ($numinvalid) {
                $output .= '<li>'.&mt('reference is to file with a name containing invalid characters').'</li>'."\n";
            }
            if ($numexisting) {
                $output .= '<li>'.&mt('reference is to an existing file at the specified location').'</li>'."\n";
            }
            $output .= '</ul><br />';
        } elsif ($numremref) {
            $output .= '<p>'.&mt('None to upload, as all references are to URLs pointing to another server.').'</p>';
        } elsif ($numinvalid) {
            $output .= '<p>'.&mt('None to upload, as all references are to files with names containing invalid characters.').'</p>';
        } elsif ($numexisting) {
            $output .= '<p>'.&mt('None to upload, as all references are to existing files.').'</p>';
        }
        $output .= $upload_output.'<br />';
    }
    my ($pathchange_output,$chgcount);
    $chgcount = $num;
    if (keys(%pathchanges) > 0) {
        foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%pathchanges)) {
            if ($num) {
                $output .= &embedded_file_element('pathchange',$chgcount,
                                                  $embed_file,\%mapping,
                                                  $allfiles,$codebase);
            } else {
                $pathchange_output .= 
                    &start_data_table_row().
                    '<td><input type ="checkbox" name="namechange" value="'.
                    $chgcount.'" checked="checked" /></td>'.
                    '<td>'.$mapping{$embed_file}.'</td>'.
                    '<td>'.$embed_file.
                    &embedded_file_element('pathchange',$numpathchg,$embed_file,
                                           \%mapping,$allfiles,$codebase).
                    '</td>'.&end_data_table_row();
            }
            $numpathchg ++;
            $chgcount ++;
        }
    }
    if ($num) {
        if ($numpathchg) {
            $output .= '<input type ="hidden" name="number_pathchange_items" value="'.
                       $numpathchg.'" />'."\n";
        }
        if (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank') || 
            ($actionurl eq '/adm/imsimport')) {
            $output .= '<input type="hidden" name="phase" value="three" />'."\n";
        } elsif ($actionurl eq '/adm/portfolio' || $actionurl eq '/adm/coursegrp_portfolio') {
            $output .= '<input type="hidden" name="action" value="upload_embedded" />';
        }
        $output .=  '<input type ="submit" value="'.&mt('Upload Listed Files').'" />'."\n".
                    &mt('(only files for which a location has been provided will be uploaded)').'</form>'."\n";
    } elsif ($numpathchg) {
        my %pathchange = ();
        $output .= &modify_html_form('pathchange',$actionurl,$state,\%pathchange,$pathchange_output);
        if (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
            $output .= '<p>'.&mt('or').'</p>'; 
        } 
    }
    return ($output,$num,$numpathchg);
}

sub embedded_file_element {
    my ($context,$num,$embed_file,$mapping,$allfiles,$codebase) = @_;
    return unless ((ref($mapping) eq 'HASH') && (ref($allfiles) eq 'HASH') &&
                   (ref($codebase) eq 'HASH'));
    my $output;
    if ($context eq 'upload_embedded') {
       $output = '<input name="embedded_item_'.$num.'" type="file" value="" />'."\n";
    }
    $output .= '<input name="embedded_orig_'.$num.'" type="hidden" value="'.
               &escape($embed_file).'" />';
    unless (($context eq 'upload_embedded') && 
            ($mapping->{$embed_file} eq $embed_file)) {
        $output .='
        <input name="embedded_ref_'.$num.'" type="hidden" value="'.&escape($mapping->{$embed_file}).'" />';
    }
    my $attrib;
    if (ref($allfiles->{$mapping->{$embed_file}}) eq 'ARRAY') {
        $attrib = &escape(join(':',@{$allfiles->{$mapping->{$embed_file}}}));
    }
    $output .=
        "\n\t\t".
        '<input name="embedded_attrib_'.$num.'" type="hidden" value="'.
        $attrib.'" />';
    if (exists($codebase->{$mapping->{$embed_file}})) {
        $output .=
            "\n\t\t".
            '<input name="codebase_'.$num.'" type="hidden" value="'.
            &escape($codebase->{$mapping->{$embed_file}}).'" />';
    }
    return $output;
}

sub upload_embedded {
    my ($context,$dirpath,$uname,$udom,$dir_root,$url_root,$group,$disk_quota,
        $current_disk_usage,$hiddenstate,$actionurl) = @_;
    my (%pathchange,$output,$modifyform,$footer,$returnflag);
    for (my $i=0; $i<$env{'form.number_embedded_items'}; $i++) {
        next if (!exists($env{'form.embedded_item_'.$i.'.filename'}));
        my $orig_uploaded_filename =
            $env{'form.embedded_item_'.$i.'.filename'};
        foreach my $type ('orig','ref','attrib','codebase') {
            if ($env{'form.embedded_'.$type.'_'.$i} ne '') {
                $env{'form.embedded_'.$type.'_'.$i} =
                    &unescape($env{'form.embedded_'.$type.'_'.$i});
            }
        }
        my ($path,$fname) =
            ($env{'form.embedded_orig_'.$i} =~ m{(.*/)([^/]*)});
        # no path, whole string is fname
        if (!$fname) { $fname = $env{'form.embedded_orig_'.$i} };
        $fname = &Apache::lonnet::clean_filename($fname);
        # See if there is anything left
        next if ($fname eq '');

        # Check if file already exists as a file or directory.
        my ($state,$msg);
        if ($context eq 'portfolio') {
            my $port_path = $dirpath;
            if ($group ne '') {
                $port_path = "groups/$group/$port_path";
            }
            ($state,$msg) = &check_for_upload($env{'form.currentpath'}.$path,
                                              $fname,$group,'embedded_item_'.$i,
                                              $dir_root,$port_path,$disk_quota,
                                              $current_disk_usage,$uname,$udom);
            if ($state eq 'will_exceed_quota'
                || $state eq 'file_locked') {
                $output .= $msg;
                next;
            }
        } elsif (($context eq 'author') || ($context eq 'testbank')) {
            ($state,$msg) = &check_for_existing($path,$fname,'embedded_item_'.$i);
            if ($state eq 'exists') {
                $output .= $msg;
                next;
            }
        }
        # Check if extension is valid
        if (($fname =~ /\.(\w+)$/) &&
            (&Apache::loncommon::fileembstyle($1) eq 'hdn')) {
            $output .= &mt('Invalid file extension ([_1]) - reserved for LONCAPA use - rename the file with a different extension and re-upload. ',$1).'<br />';
            next;
        } elsif (($fname =~ /\.(\w+)$/) &&
                 (!defined(&Apache::loncommon::fileembstyle($1)))) {
            $output .= &mt('Unrecognized file extension ([_1]) - rename the file with a proper extension and re-upload.',$1).'<br />';
            next;
        } elsif ($fname=~/\.(\d+)\.(\w+)$/) {
            $output .= &mt('File name not allowed - rename the file to remove the number immediately before the file extension([_1]) and re-upload.',$2).'<br />';
            next;
        }

        $env{'form.embedded_item_'.$i.'.filename'}=$fname;
        if ($context eq 'portfolio') {
            my $result;
            if ($state eq 'existingfile') {
                $result=
                    &Apache::lonnet::userfileupload('embedded_item_'.$i,'existingfile',
                                                    $dirpath.$env{'form.currentpath'}.$path);
            } else {
                $result=
                    &Apache::lonnet::userfileupload('embedded_item_'.$i,'',
                                                    $dirpath.
                                                    $env{'form.currentpath'}.$path);
                if ($result !~ m|^/uploaded/|) {
                    $output .= '<span class="LC_error">'
                               .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
                               ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
                               .'</span><br />';
                    next;
                } else {
                    $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
                               $path.$fname.'</span>').'<br />';     
                }
            }
        } elsif ($context eq 'coursedoc') {
            my $result =
                &Apache::lonnet::userfileupload('embedded_item_'.$i,'coursedoc',
                                                $dirpath.'/'.$path);
            if ($result !~ m|^/uploaded/|) {
                $output .= '<span class="LC_error">'
                           .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
                           ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
                           .'</span><br />';
                    next;
            } else {
                $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
                           $path.$fname.'</span>').'<br />';
            }
        } else {
# Save the file
            my $target = $env{'form.embedded_item_'.$i};
            my $fullpath = $dir_root.$dirpath.'/'.$path;
            my $dest = $fullpath.$fname;
            my $url = $url_root.$dirpath.'/'.$path.$fname;
            my @parts=split(/\//,$fullpath);
            my $count;
            my $filepath = $dir_root;
            for ($count=4;$count<=$#parts;$count++) {
                $filepath .= "/$parts[$count]";
                if ((-e $filepath)!=1) {
                    mkdir($filepath,0770);
                }
            }
            my $fh;
            if (!open($fh,'>'.$dest)) {
                &Apache::lonnet::logthis('Failed to create '.$dest);
                $output .= '<span class="LC_error">'.
                           &mt('An error occurred while trying to upload [_1] for embedded element [_2].',$orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
                           '</span><br />';
            } else {
                if (!print $fh $env{'form.embedded_item_'.$i}) {
                    &Apache::lonnet::logthis('Failed to write to '.$dest);
                    $output .= '<span class="LC_error">'.
                              &mt('An error occurred while writing the file [_1] for embedded element [_2].',$orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
                              '</span><br />';
                } else {
                    $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
                               $url.'</span>').'<br />';
                    unless ($context eq 'testbank') {
                        $footer .= &mt('View embedded file: [_1]',
                                       '<a href="'.$url.'">'.$fname.'</a>').'<br />';
                    }
                }
                close($fh);
            }
        }
        if ($env{'form.embedded_ref_'.$i}) {
            $pathchange{$i} = 1;
        }
    }
    if ($output) {
        $output = '<p>'.$output.'</p>';
    }
    $output .= &modify_html_form('upload_embedded',$actionurl,$hiddenstate,\%pathchange);
    $returnflag = 'ok';
    if (keys(%pathchange) > 0) {
        if ($context eq 'portfolio') {
            $output .= '<p>'.&mt('or').'</p>';
        } elsif ($context eq 'testbank') {
            $output .=  '<p>'.&mt('Or [_1]continue[_2] the testbank import without modifying the references(s).','<a href="javascript:document.testbankForm.submit();">','</a>').'</p>';
            $returnflag = 'modify_orightml';
        }
    }
    return ($output.$footer,$returnflag);
}

sub modify_html_form {
    my ($context,$actionurl,$hiddenstate,$pathchange,$pathchgtable) = @_;
    my $end = 0;
    my $modifyform;
    if ($context eq 'upload_embedded') {
        return unless (ref($pathchange) eq 'HASH');
        if ($env{'form.number_embedded_items'}) {
            $end += $env{'form.number_embedded_items'};
        }
        if ($env{'form.number_pathchange_items'}) {
            $end += $env{'form.number_pathchange_items'};
        }
        if ($end) {
            for (my $i=0; $i<$end; $i++) {
                if ($i < $env{'form.number_embedded_items'}) {
                    next unless($pathchange->{$i});
                }
                $modifyform .=
                    &start_data_table_row().
                    '<td><input type ="checkbox" name="namechange" value="'.$i.'" '.
                    'checked="checked" /></td>'.
                    '<td>'.$env{'form.embedded_ref_'.$i}.
                    '<input type="hidden" name="embedded_ref_'.$i.'" value="'.
                    &escape($env{'form.embedded_ref_'.$i}).'" />'.
                    '<input type="hidden" name="embedded_codebase_'.$i.'" value="'.
                    &escape($env{'form.embedded_codebase_'.$i}).'" />'.
                    '<input type="hidden" name="embedded_attrib_'.$i.'" value="'.
                    &escape($env{'form.embedded_attrib_'.$i}).'" /></td>'.
                    '<td>'.$env{'form.embedded_orig_'.$i}.
                    '<input type="hidden" name="embedded_orig_'.$i.'" value="'.
                    &escape($env{'form.embedded_orig_'.$i}).'" /></td>'.
                    &end_data_table_row();
            } 
        }
    } else {
        $modifyform = $pathchgtable;
        if (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
            $hiddenstate .= '<input type="hidden" name="phase" value="four" />';
        } elsif (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
            $hiddenstate .= '<input type="hidden" name="action" value="modify_orightml" />';
        }
    }
    if ($modifyform) {
        return '<h3>'.&mt('Changes in content of HTML file required').'</h3>'."\n".
               '<p>'.&mt('Changes need to be made to the reference(s) used for one or more of the dependencies, if your HTML file is to work correctly:').'<ol>'."\n".
               '<li>'.&mt('For consistency between the reference(s) and the location of the corresponding stored file within LON-CAPA.').'</li>'."\n".
               '<li>'.&mt('To change absolute paths to relative paths, or replace directory traversal via "../" within the original reference.').'</li>'."\n".
               '</ol></p>'."\n".'<p>'.
               &mt('LON-CAPA can make the required changes to your HTML file.').'</p>'."\n".
               '<form method="post" name="refchanger" action="'.$actionurl.'">'.
               &start_data_table()."\n".
               &start_data_table_header_row().
               '<th>'.&mt('Change?').'</th>'.
               '<th>'.&mt('Current reference').'</th>'.
               '<th>'.&mt('Required reference').'</th>'.
               &end_data_table_header_row()."\n".
               $modifyform.
               &end_data_table().'<br />'."\n".$hiddenstate.
               '<input type="submit" name="pathchanges" value="'.&mt('Modify HTML file').'" />'.
               '</form>'."\n";
    }
    return;
}

sub modify_html_refs {
    my ($context,$dirpath,$uname,$udom,$dir_root) = @_;
    my $container;
    if ($context eq 'portfolio') {
        $container = $env{'form.container'};
    } elsif ($context eq 'coursedoc') {
        $container = $env{'form.primaryurl'};
    } else {
        $container = $env{'form.filename'};
        $container =~ s{^/priv/(\Q$uname\E)/(.*)}{/home/$1/public_html/$2};
    }
    my (%allfiles,%codebase,$output,$content);
    my @changes = &get_env_multiple('form.namechange');
    return unless (@changes > 0);
    if (($context eq 'portfolio') || ($context eq 'coursedoc')) {
        return unless ($container =~ m{^/uploaded/\Q$udom\E/\Q$uname\E/});
        $content = &Apache::lonnet::getfile($container);
        return if ($content eq '-1');
    } else {
        return unless ($container =~ /^\Q$dir_root\E/); 
        if (open(my $fh,"<$container")) {
            $content = join('', <$fh>);
            close($fh);
        } else {
            return;
        }
    }
    my ($count,$codebasecount) = (0,0);
    my $mm = new File::MMagic;
    my $mime_type = $mm->checktype_contents($content);
    if ($mime_type eq 'text/html') {
        my $parse_result = 
            &Apache::lonnet::extract_embedded_items($container,\%allfiles,
                                                    \%codebase,\$content);
        if ($parse_result eq 'ok') {
            foreach my $i (@changes) {
                my $orig = &unescape($env{'form.embedded_orig_'.$i});
                my $ref = &unescape($env{'form.embedded_ref_'.$i});
                if ($allfiles{$ref}) {
                    my $newname =  $orig;
                    my ($attrib_regexp,$codebase);
                    my $attrib_regexp = &unescape($env{'form.embedded_attrib_'.$i});
                    if ($attrib_regexp =~ /:/) {
                        $attrib_regexp =~ s/\:/|/g;
                    }
                    if ($content =~ m{($attrib_regexp\s*=\s*['"]?)\Q$ref\E(['"]?)}) {
                        my $numchg = ($content =~ s{($attrib_regexp\s*=\s*['"]?)\Q$ref\E(['"]?)}{$1$newname$2}gi);
                        $count += $numchg;
                    }
                    if ($env{'form.embedded_codebase_'.$i} ne '') {
                        my $codebase = &unescape($env{'form.embedded_codebase_'.$i});
                        my $numchg = ($content =~ s/(codebase\s*=\s*["']?)\Q$codebase\E(["']?)/$1.$2/i); #' stupid emacs
                        $codebasecount ++;
                    }
                }
            }
            if ($count || $codebasecount) {
                my $saveresult;
                if ($context eq 'portfolio' || $context eq 'coursedoc') {
                    my $url = &Apache::lonnet::store_edited_file($container,$content,$udom,$uname,\$saveresult);
                    if ($url eq $container) {
                        my ($fname) = ($container =~ m{/([^/]+)$});
                        $output = '<p>'.&mt('Updated [quant,_1,reference] in [_2].',
                                            $count,'<span class="LC_filename">'.
                                            $fname.'</span>').'</p>'; 
                    } else {
                         $output = '<p class="LC_error">'.
                                   &mt('Error: update failed for: [_1].',
                                   '<span class="LC_filename">'.
                                   $container.'</span>').'</p>';
                    }
                } else {
                    if (open(my $fh,">$container")) {
                        print $fh $content;
                        close($fh);
                        $output = '<p>'.&mt('Updated [quant,_1,reference] in [_2].',
                                  $count,'<span class="LC_filename">'.
                                  $container.'</span>').'</p>';
                    } else {
                         $output = '<p class="LC_error">'.
                                   &mt('Error: could not update [_1].',
                                   '<span class="LC_filename">'.
                                   $container.'</span>').'</p>';
                    }
                }
            }
        } else {
            &logthis('Failed to parse '.$container.
                     ' to modify references: '.$parse_result);
        }
    }
    return $output;
}

sub check_for_existing {
    my ($path,$fname,$element) = @_;
    my ($state,$msg);
    if (-d $path.'/'.$fname) {
        $state = 'exists';
        $msg = &mt('Unable to upload [_1]. A directory by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
    } elsif (-e $path.'/'.$fname) {
        $state = 'exists';
        $msg = &mt('Unable to upload [_1]. A file by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
    }
    if ($state eq 'exists') {
        $msg = '<span class="LC_error">'.$msg.'</span><br />';
    }
    return ($state,$msg);
}

sub check_for_upload {
    my ($path,$fname,$group,$element,$portfolio_root,$port_path,
        $disk_quota,$current_disk_usage,$uname,$udom) = @_;
    my $filesize = length($env{'form.'.$element});
    if (!$filesize) {
        my $msg = '<span class="LC_error">'.
                  &mt('Unable to upload [_1]. (size = [_2] bytes)', 
                      '<span class="LC_filename">'.$fname.'</span>',
                      $filesize).'<br />'.
                  &mt('Either the file you uploaded was empty, or your web browser was unable to read its contents.').'<br />'; 
                  '</span>';
        return ('zero_bytes',$msg);
    }
    $filesize =  $filesize/1000; #express in k (1024?)
    my $getpropath = 1;
    my @dir_list = &Apache::lonnet::dirlist($portfolio_root.$path,$udom,$uname,
                                            $getpropath);
    my $found_file = 0;
    my $locked_file = 0;
    foreach my $line (@dir_list) {
        my ($file_name,$rest)=split(/\&/,$line,2);
        if ($file_name eq $fname){
            $file_name = $path.$file_name;
            if ($group ne '') {
                $file_name = $group.$file_name;
            }
            $found_file = 1;
            if (&Apache::lonnet::is_locked($file_name,$udom,$uname) eq 'true') {
                $locked_file = 1;
            } else {
                my @info = split(/\&/,$rest);
                my $currsize = $info[6]/1000;
                if ($currsize < $filesize) {
                    my $extra = $filesize - $currsize;
                    if (($current_disk_usage + $extra) > $disk_quota) {
                        my $msg = '<span class="LC_error">'.
                                  &mt('Unable to upload [_1]. (size = [_2] kilobytes). Disk quota will be exceeded if existing (smaller) file with same name (size = [_3] kilobytes) is replaced.',
                                      '<span class="LC_filename">'.$fname.'</span>',$filesize,$currsize).'</span>'.
                                  '<br />'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',
                                               $disk_quota,$current_disk_usage);
                        return ('will_exceed_quota',$msg);
                    }
                }
            }
        }
    }
    if (($current_disk_usage + $filesize) > $disk_quota){
        my $msg = '<span class="LC_error">'.
                &mt('Unable to upload [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.','<span class="LC_filename">'.$fname.'</span>',$filesize).'</span>'.
                  '<br />'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',$disk_quota,$current_disk_usage);
        return ('will_exceed_quota',$msg);
    } elsif ($found_file) {
        if ($locked_file) {
            my $msg = '<span class="LC_error">';
            $msg .= &mt('Unable to upload [_1]. A locked file by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>','<span class="LC_filename">'.$port_path.$env{'form.currentpath'}.'</span>');
            $msg .= '</span><br />';
            $msg .= &mt('You will be able to rename or delete existing [_1] after a grade has been assigned.','<span class="LC_filename">'.$fname.'</span>');
            return ('file_locked',$msg);
        } else {
            my $msg = '<span class="LC_error">';
            $msg .= &mt(' A file by that name: [_1] was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$port_path.$env{'form.currentpath'});
            $msg .= '</span>';
            return ('existingfile',$msg);
        }
    }
}

sub check_for_traversal {
    my ($path,$url,$toplevel) = @_;
    my @parts=split(/\//,$path);
    my $cleanpath;
    my $fullpath = $url;
    for (my $i=0;$i<@parts;$i++) {
        next if ($parts[$i] eq '.');
        if ($parts[$i] eq '..') {
            $fullpath =~ s{([^/]+/)$}{};
        } else {
            $fullpath .= $parts[$i].'/';
        }
    }
    if ($fullpath =~ /^\Q$url\E(.*)$/) {
        $cleanpath = $1;
    } elsif ($fullpath =~ /^\Q$toplevel\E(.*)$/) {
        my $curr_toprel = $1;
        my @parts = split(/\//,$curr_toprel);
        my ($url_toprel) = ($url =~ /^\Q$toplevel\E(.*)$/);
        my @urlparts = split(/\//,$url_toprel);
        my $doubledots;
        my $startdiff = -1;
        for (my $i=0; $i<@urlparts; $i++) {
            if ($startdiff == -1) {
                unless ($urlparts[$i] eq $parts[$i]) {
                    $startdiff = $i;
                    $doubledots .= '../';
                }
            } else {
                $doubledots .= '../';
            }
        }
        if ($startdiff > -1) {
            $cleanpath = $doubledots;
            for (my $i=$startdiff; $i<@parts; $i++) {
                $cleanpath .= $parts[$i].'/';
            }
        }
    }
    $cleanpath =~ s{(/)$}{};
    return $cleanpath;
}

=pod

=back

=head1 CSV Upload/Handling functions

=over 4

=item * &upfile_store($r)

Store uploaded file, $r should be the HTTP Request object,
needs $env{'form.upfile'}
returns $datatoken to be put into hidden field

=cut

sub upfile_store {
    my $r=shift;
    $env{'form.upfile'}=~s/\r/\n/gs;
    $env{'form.upfile'}=~s/\f/\n/gs;
    $env{'form.upfile'}=~s/\n+/\n/gs;
    $env{'form.upfile'}=~s/\n+$//gs;

    my $datatoken=$env{'user.name'}.'_'.$env{'user.domain'}.
	'_enroll_'.$env{'request.course.id'}.'_'.time.'_'.$$;
    {
        my $datafile = $r->dir_config('lonDaemons').
                           '/tmp/'.$datatoken.'.tmp';
        if ( open(my $fh,">$datafile") ) {
            print $fh $env{'form.upfile'};
            close($fh);
        }
    }
    return $datatoken;
}

=pod

=item * &load_tmp_file($r)

Load uploaded file from tmp, $r should be the HTTP Request object,
needs $env{'form.datatoken'},
sets $env{'form.upfile'} to the contents of the file

=cut

sub load_tmp_file {
    my $r=shift;
    my @studentdata=();
    {
        my $studentfile = $r->dir_config('lonDaemons').
                              '/tmp/'.$env{'form.datatoken'}.'.tmp';
        if ( open(my $fh,"<$studentfile") ) {
            @studentdata=<$fh>;
            close($fh);
        }
    }
    $env{'form.upfile'}=join('',@studentdata);
}

=pod

=item * &upfile_record_sep()

Separate uploaded file into records
returns array of records,
needs $env{'form.upfile'} and $env{'form.upfiletype'}

=cut

sub upfile_record_sep {
    if ($env{'form.upfiletype'} eq 'xml') {
    } else {
	my @records;
	foreach my $line (split(/\n/,$env{'form.upfile'})) {
	    if ($line=~/^\s*$/) { next; }
	    push(@records,$line);
	}
	return @records;
    }
}

=pod

=item * &record_sep($record)

Separate a record into fields $record should be an item from the upfile_record_sep(), needs $env{'form.upfiletype'}

=cut

sub takeleft {
    my $index=shift;
    return substr('0000'.$index,-4,4);
}

sub record_sep {
    my $record=shift;
    my %components=();
    if ($env{'form.upfiletype'} eq 'xml') {
    } elsif ($env{'form.upfiletype'} eq 'space') {
        my $i=0;
        foreach my $field (split(/\s+/,$record)) {
            $field=~s/^(\"|\')//;
            $field=~s/(\"|\')$//;
            $components{&takeleft($i)}=$field;
            $i++;
        }
    } elsif ($env{'form.upfiletype'} eq 'tab') {
        my $i=0;
        foreach my $field (split(/\t/,$record)) {
            $field=~s/^(\"|\')//;
            $field=~s/(\"|\')$//;
            $components{&takeleft($i)}=$field;
            $i++;
        }
    } else {
        my $separator=',';
        if ($env{'form.upfiletype'} eq 'semisv') {
            $separator=';';
        }
        my $i=0;
# the character we are looking for to indicate the end of a quote or a record 
        my $looking_for=$separator;
# do not add the characters to the fields
        my $ignore=0;
# we just encountered a separator (or the beginning of the record)
        my $just_found_separator=1;
# store the field we are working on here
        my $field='';
# work our way through all characters in record
        foreach my $character ($record=~/(.)/g) {
            if ($character eq $looking_for) {
               if ($character ne $separator) {
# Found the end of a quote, again looking for separator
                  $looking_for=$separator;
                  $ignore=1;
               } else {
# Found a separator, store away what we got
                  $components{&takeleft($i)}=$field;
	          $i++;
                  $just_found_separator=1;
                  $ignore=0;
                  $field='';
               }
               next;
            }
# single or double quotation marks after a separator indicate beginning of a quote
# we are now looking for the end of the quote and need to ignore separators
            if ((($character eq '"') || ($character eq "'")) && ($just_found_separator))  {
               $looking_for=$character;
               next;
            }
# ignore would be true after we reached the end of a quote
            if ($ignore) { next; }
            if (($just_found_separator) && ($character=~/\s/)) { next; }
            $field.=$character;
            $just_found_separator=0; 
        }
# catch the very last entry, since we never encountered the separator
        $components{&takeleft($i)}=$field;
    }
    return %components;
}

######################################################
######################################################

=pod

=item * &upfile_select_html()

Return HTML code to select a file from the users machine and specify 
the file type.

=cut

######################################################
######################################################
sub upfile_select_html {
    my %Types = (
                 csv   => &mt('CSV (comma separated values, spreadsheet)'),
                 semisv => &mt('Semicolon separated values'),
                 space => &mt('Space separated'),
                 tab   => &mt('Tabulator separated'),
#                 xml   => &mt('HTML/XML'),
                 );
    my $Str = '<input type="file" name="upfile" size="50" />'.
        '<br />'.&mt('Type').': <select name="upfiletype">';
    foreach my $type (sort(keys(%Types))) {
        $Str .= '<option value="'.$type.'" >'.$Types{$type}."</option>\n";
    }
    $Str .= "</select>\n";
    return $Str;
}

sub get_samples {
    my ($records,$toget) = @_;
    my @samples=({});
    my $got=0;
    foreach my $rec (@$records) {
	my %temp = &record_sep($rec);
	if (! grep(/\S/, values(%temp))) { next; }
	if (%temp) {
	    $samples[$got]=\%temp;
	    $got++;
	    if ($got == $toget) { last; }
	}
    }
    return \@samples;
}

######################################################
######################################################

=pod

=item * &csv_print_samples($r,$records)

Prints a table of sample values from each column uploaded $r is an
Apache Request ref, $records is an arrayref from
&Apache::loncommon::upfile_record_sep

=cut

######################################################
######################################################
sub csv_print_samples {
    my ($r,$records) = @_;
    my $samples = &get_samples($records,5);

    $r->print(&mt('Samples').'<br />'.&start_data_table().
              &start_data_table_header_row());
    foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) { 
        $r->print('<th>'.&mt('Column [_1]',($sample+1)).'</th>'); }
    $r->print(&end_data_table_header_row());
    foreach my $hash (@$samples) {
	$r->print(&start_data_table_row());
	foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
	    $r->print('<td>');
	    if (defined($$hash{$sample})) { $r->print($$hash{$sample}); }
	    $r->print('</td>');
	}
	$r->print(&end_data_table_row());
    }
    $r->print(&end_data_table().'<br />'."\n");
}

######################################################
######################################################

=pod

=item * &csv_print_select_table($r,$records,$d)

Prints a table to create associations between values and table columns.

$r is an Apache Request ref,
$records is an arrayref from &Apache::loncommon::upfile_record_sep,
$d is an array of 2 element arrays (internal name, displayed name,defaultcol)

=cut

######################################################
######################################################
sub csv_print_select_table {
    my ($r,$records,$d) = @_;
    my $i=0;
    my $samples = &get_samples($records,1);
    $r->print(&mt('Associate columns with student attributes.')."\n".
	      &start_data_table().&start_data_table_header_row().
              '<th>'.&mt('Attribute').'</th>'.
              '<th>'.&mt('Column').'</th>'.
              &end_data_table_header_row()."\n");
    foreach my $array_ref (@$d) {
	my ($value,$display,$defaultcol)=@{ $array_ref };
	$r->print(&start_data_table_row().'<td>'.$display.'</td>');

	$r->print('<td><select name="f'.$i.'"'.
		  ' onchange="javascript:flip(this.form,'.$i.');">');
	$r->print('<option value="none"></option>');
	foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
	    $r->print('<option value="'.$sample.'"'.
                      ($sample eq $defaultcol ? ' selected="selected" ' : '').
                      '>'.&mt('Column [_1]',($sample+1)).'</option>');
	}
	$r->print('</select></td>'.&end_data_table_row()."\n");
	$i++;
    }
    $r->print(&end_data_table());
    $i--;
    return $i;
}

######################################################
######################################################

=pod

=item * &csv_samples_select_table($r,$records,$d)

Prints a table of sample values from the upload and can make associate samples to internal names.

$r is an Apache Request ref,
$records is an arrayref from &Apache::loncommon::upfile_record_sep,
$d is an array of 2 element arrays (internal name, displayed name)

=cut

######################################################
######################################################
sub csv_samples_select_table {
    my ($r,$records,$d) = @_;
    my $i=0;
    #
    my $max_samples = 5;
    my $samples = &get_samples($records,$max_samples);
    $r->print(&start_data_table().
              &start_data_table_header_row().'<th>'.
              &mt('Field').'</th><th>'.&mt('Samples').'</th>'.
              &end_data_table_header_row());

    foreach my $key (sort(keys(%{ $samples->[0] }))) {
	$r->print(&start_data_table_row().'<td><select name="f'.$i.'"'.
		  ' onchange="javascript:flip(this.form,'.$i.');">');
	foreach my $option (@$d) {
	    my ($value,$display,$defaultcol)=@{ $option };
	    $r->print('<option value="'.$value.'"'.
                      ($i eq $defaultcol ? ' selected="selected" ':'').'>'.
                      $display.'</option>');
	}
	$r->print('</select></td><td>');
	foreach my $line (0..($max_samples-1)) {
	    if (defined($samples->[$line]{$key})) { 
		$r->print($samples->[$line]{$key}."<br />\n"); 
	    }
	}
	$r->print('</td>'.&end_data_table_row());
	$i++;
    }
    $r->print(&end_data_table());
    $i--;
    return($i);
}

######################################################
######################################################

=pod

=item * &clean_excel_name($name)

Returns a replacement for $name which does not contain any illegal characters.

=cut

######################################################
######################################################
sub clean_excel_name {
    my ($name) = @_;
    $name =~ s/[:\*\?\/\\]//g;
    if (length($name) > 31) {
        $name = substr($name,0,31);
    }
    return $name;
}

=pod

=item * &check_if_partid_hidden($id,$symb,$udom,$uname)

Returns either 1 or undef

1 if the part is to be hidden, undef if it is to be shown

Arguments are:

$id the id of the part to be checked
$symb, optional the symb of the resource to check
$udom, optional the domain of the user to check for
$uname, optional the username of the user to check for

=cut

sub check_if_partid_hidden {
    my ($id,$symb,$udom,$uname) = @_;
    my $hiddenparts=&Apache::lonnet::EXT('resource.0.hiddenparts',
					 $symb,$udom,$uname);
    my $truth=1;
    #if the string starts with !, then the list is the list to show not hide
    if ($hiddenparts=~s/^\s*!//) { $truth=undef; }
    my @hiddenlist=split(/,/,$hiddenparts);
    foreach my $checkid (@hiddenlist) {
	if ($checkid =~ /^\s*\Q$id\E\s*$/) { return $truth; }
    }
    return !$truth;
}


############################################################
############################################################

=pod

=back 

=head1 cgi-bin script and graphing routines

=over 4

=item * &get_cgi_id()

Inputs: none

Returns an id which can be used to pass environment variables
to various cgi-bin scripts.  These environment variables will
be removed from the users environment after a given time by
the routine &Apache::lonnet::transfer_profile_to_env.

=cut

############################################################
############################################################
my $uniq=0;
sub get_cgi_id {
    $uniq=($uniq+1)%100000;
    return (time.'_'.$$.'_'.$uniq);
}

############################################################
############################################################

=pod

=item * &DrawBarGraph()

Facilitates the plotting of data in a (stacked) bar graph.
Puts plot definition data into the users environment in order for 
graph.png to plot it.  Returns an <img> tag for the plot.
The bars on the plot are labeled '1','2',...,'n'.

Inputs:

=over 4

=item $Title: string, the title of the plot

=item $xlabel: string, text describing the X-axis of the plot

=item $ylabel: string, text describing the Y-axis of the plot

=item $Max: scalar, the maximum Y value to use in the plot
If $Max is < any data point, the graph will not be rendered.

=item $colors: array ref holding the colors to be used for the data sets when
they are plotted.  If undefined, default values will be used.

=item $labels: array ref holding the labels to use on the x-axis for the bars.

=item @Values: An array of array references.  Each array reference holds data
to be plotted in a stacked bar chart.

=item If the final element of @Values is a hash reference the key/value
pairs will be added to the graph definition.

=back

Returns:

An <img> tag which references graph.png and the appropriate identifying
information for the plot.

=cut

############################################################
############################################################
sub DrawBarGraph {
    my ($Title,$xlabel,$ylabel,$Max,$colors,$labels,@Values)=@_;
    #
    if (! defined($colors)) {
        $colors = ['#33ff00', 
                  '#0033cc', '#990000', '#aaaa66', '#663399', '#ff9933',
                  '#66ccff', '#ff9999', '#cccc33', '#660000', '#33cc66',
                  ]; 
    }
    my $extra_settings = {};
    if (ref($Values[-1]) eq 'HASH') {
        $extra_settings = pop(@Values);
    }
    #
    my $identifier = &get_cgi_id();
    my $id = 'cgi.'.$identifier;        
    if (! @Values || ref($Values[0]) ne 'ARRAY') {
        return '';
    }
    #
    my @Labels;
    if (defined($labels)) {
        @Labels = @$labels;
    } else {
        for (my $i=0;$i<@{$Values[0]};$i++) {
            push (@Labels,$i+1);
        }
    }
    #
    my $NumBars = scalar(@{$Values[0]});
    if ($NumBars < scalar(@Labels)) { $NumBars = scalar(@Labels); }
    my %ValuesHash;
    my $NumSets=1;
    foreach my $array (@Values) {
        next if (! ref($array));
        $ValuesHash{$id.'.data.'.$NumSets++} = 
            join(',',@$array);
    }
    #
    my ($height,$width,$xskip,$bar_width) = (200,120,1,15);
    if ($NumBars < 3) {
        $width = 120+$NumBars*32;
        $xskip = 1;
        $bar_width = 30;
    } elsif ($NumBars < 5) {
        $width = 120+$NumBars*20;
        $xskip = 1;
        $bar_width = 20;
    } elsif ($NumBars < 10) {
        $width = 120+$NumBars*15;
        $xskip = 1;
        $bar_width = 15;
    } elsif ($NumBars <= 25) {
        $width = 120+$NumBars*11;
        $xskip = 5;
        $bar_width = 8;
    } elsif ($NumBars <= 50) {
        $width = 120+$NumBars*8;
        $xskip = 5;
        $bar_width = 4;
    } else {
        $width = 120+$NumBars*8;
        $xskip = 5;
        $bar_width = 4;
    }
    #
    $Max = 1 if ($Max < 1);
    if ( int($Max) < $Max ) {
        $Max++;
        $Max = int($Max);
    }
    $Title  = '' if (! defined($Title));
    $xlabel = '' if (! defined($xlabel));
    $ylabel = '' if (! defined($ylabel));
    $ValuesHash{$id.'.title'}    = &escape($Title);
    $ValuesHash{$id.'.xlabel'}   = &escape($xlabel);
    $ValuesHash{$id.'.ylabel'}   = &escape($ylabel);
    $ValuesHash{$id.'.y_max_value'} = $Max;
    $ValuesHash{$id.'.NumBars'}  = $NumBars;
    $ValuesHash{$id.'.NumSets'}  = $NumSets;
    $ValuesHash{$id.'.PlotType'} = 'bar';
    $ValuesHash{$id.'.Colors'}   = join(',',@{$colors});
    $ValuesHash{$id.'.height'}   = $height;
    $ValuesHash{$id.'.width'}    = $width;
    $ValuesHash{$id.'.xskip'}    = $xskip;
    $ValuesHash{$id.'.bar_width'} = $bar_width;
    $ValuesHash{$id.'.labels'} = join(',',@Labels);
    #
    # Deal with other parameters
    while (my ($key,$value) = each(%$extra_settings)) {
        $ValuesHash{$id.'.'.$key} = $value;
    }
    #
    &Apache::lonnet::appenv(\%ValuesHash);
    return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
}

############################################################
############################################################

=pod

=item * &DrawXYGraph()

Facilitates the plotting of data in an XY graph.
Puts plot definition data into the users environment in order for 
graph.png to plot it.  Returns an <img> tag for the plot.

Inputs:

=over 4

=item $Title: string, the title of the plot

=item $xlabel: string, text describing the X-axis of the plot

=item $ylabel: string, text describing the Y-axis of the plot

=item $Max: scalar, the maximum Y value to use in the plot
If $Max is < any data point, the graph will not be rendered.

=item $colors: Array ref containing the hex color codes for the data to be 
plotted in.  If undefined, default values will be used.

=item $Xlabels: Array ref containing the labels to be used for the X-axis.

=item $Ydata: Array ref containing Array refs.  
Each of the contained arrays will be plotted as a separate curve.

=item %Values: hash indicating or overriding any default values which are 
passed to graph.png.  
Possible values are: width, xskip, x_ticks, x_tick_offset, among others.

=back

Returns:

An <img> tag which references graph.png and the appropriate identifying
information for the plot.

=cut

############################################################
############################################################
sub DrawXYGraph {
    my ($Title,$xlabel,$ylabel,$Max,$colors,$Xlabels,$Ydata,%Values)=@_;
    #
    # Create the identifier for the graph
    my $identifier = &get_cgi_id();
    my $id = 'cgi.'.$identifier;
    #
    $Title  = '' if (! defined($Title));
    $xlabel = '' if (! defined($xlabel));
    $ylabel = '' if (! defined($ylabel));
    my %ValuesHash = 
        (
         $id.'.title'  => &escape($Title),
         $id.'.xlabel' => &escape($xlabel),
         $id.'.ylabel' => &escape($ylabel),
         $id.'.y_max_value'=> $Max,
         $id.'.labels'     => join(',',@$Xlabels),
         $id.'.PlotType'   => 'XY',
         );
    #
    if (defined($colors) && ref($colors) eq 'ARRAY') {
        $ValuesHash{$id.'.Colors'}   = join(',',@{$colors});
    }
    #
    if (! ref($Ydata) || ref($Ydata) ne 'ARRAY') {
        return '';
    }
    my $NumSets=1;
    foreach my $array (@{$Ydata}){
        next if (! ref($array));
        $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
    }
    $ValuesHash{$id.'.NumSets'} = $NumSets-1;
    #
    # Deal with other parameters
    while (my ($key,$value) = each(%Values)) {
        $ValuesHash{$id.'.'.$key} = $value;
    }
    #
    &Apache::lonnet::appenv(\%ValuesHash);
    return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
}

############################################################
############################################################

=pod

=item * &DrawXYYGraph()

Facilitates the plotting of data in an XY graph with two Y axes.
Puts plot definition data into the users environment in order for 
graph.png to plot it.  Returns an <img> tag for the plot.

Inputs:

=over 4

=item $Title: string, the title of the plot

=item $xlabel: string, text describing the X-axis of the plot

=item $ylabel: string, text describing the Y-axis of the plot

=item $colors: Array ref containing the hex color codes for the data to be 
plotted in.  If undefined, default values will be used.

=item $Xlabels: Array ref containing the labels to be used for the X-axis.

=item $Ydata1: The first data set

=item $Min1: The minimum value of the left Y-axis

=item $Max1: The maximum value of the left Y-axis

=item $Ydata2: The second data set

=item $Min2: The minimum value of the right Y-axis

=item $Max2: The maximum value of the left Y-axis

=item %Values: hash indicating or overriding any default values which are 
passed to graph.png.  
Possible values are: width, xskip, x_ticks, x_tick_offset, among others.

=back

Returns:

An <img> tag which references graph.png and the appropriate identifying
information for the plot.

=cut

############################################################
############################################################
sub DrawXYYGraph {
    my ($Title,$xlabel,$ylabel,$colors,$Xlabels,$Ydata1,$Min1,$Max1,
                                        $Ydata2,$Min2,$Max2,%Values)=@_;
    #
    # Create the identifier for the graph
    my $identifier = &get_cgi_id();
    my $id = 'cgi.'.$identifier;
    #
    $Title  = '' if (! defined($Title));
    $xlabel = '' if (! defined($xlabel));
    $ylabel = '' if (! defined($ylabel));
    my %ValuesHash = 
        (
         $id.'.title'  => &escape($Title),
         $id.'.xlabel' => &escape($xlabel),
         $id.'.ylabel' => &escape($ylabel),
         $id.'.labels' => join(',',@$Xlabels),
         $id.'.PlotType' => 'XY',
         $id.'.NumSets' => 2,
         $id.'.two_axes' => 1,
         $id.'.y1_max_value' => $Max1,
         $id.'.y1_min_value' => $Min1,
         $id.'.y2_max_value' => $Max2,
         $id.'.y2_min_value' => $Min2,
         );
    #
    if (defined($colors) && ref($colors) eq 'ARRAY') {
        $ValuesHash{$id.'.Colors'}   = join(',',@{$colors});
    }
    #
    if (! ref($Ydata1) || ref($Ydata1) ne 'ARRAY' ||
        ! ref($Ydata2) || ref($Ydata2) ne 'ARRAY'){
        return '';
    }
    my $NumSets=1;
    foreach my $array ($Ydata1,$Ydata2){
        next if (! ref($array));
        $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
    }
    #
    # Deal with other parameters
    while (my ($key,$value) = each(%Values)) {
        $ValuesHash{$id.'.'.$key} = $value;
    }
    #
    &Apache::lonnet::appenv(\%ValuesHash);
    return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
}

############################################################
############################################################

=pod

=back 

=head1 Statistics helper routines?  

Bad place for them but what the hell.

=over 4

=item * &chartlink()

Returns a link to the chart for a specific student.  

Inputs:

=over 4

=item $linktext: The text of the link

=item $sname: The students username

=item $sdomain: The students domain

=back

=back

=cut

############################################################
############################################################
sub chartlink {
    my ($linktext, $sname, $sdomain) = @_;
    my $link = '<a href="/adm/statistics?reportSelected=student_assessment'.
        '&amp;SelectedStudent='.&escape($sname.':'.$sdomain).
        '&amp;chartoutputmode='.HTML::Entities::encode('html, with all links').
       '">'.$linktext.'</a>';
}

#######################################################
#######################################################

=pod

=head1 Course Environment Routines

=over 4

=item * &restore_course_settings()

=item * &store_course_settings()

Restores/Store indicated form parameters from the course environment.
Will not overwrite existing values of the form parameters.

Inputs: 
a scalar describing the data (e.g. 'chart', 'problem_analysis')

a hash ref describing the data to be stored.  For example:
   
%Save_Parameters = ('Status' => 'scalar',
    'chartoutputmode' => 'scalar',
    'chartoutputdata' => 'scalar',
    'Section' => 'array',
    'Group' => 'array',
    'StudentData' => 'array',
    'Maps' => 'array');

Returns: both routines return nothing

=back

=cut

#######################################################
#######################################################
sub store_course_settings {
    return &store_settings($env{'request.course.id'},@_);
}

sub store_settings {
    # save to the environment
    # appenv the same items, just to be safe
    my $udom  = $env{'user.domain'};
    my $uname = $env{'user.name'};
    my ($context,$prefix,$Settings) = @_;
    my %SaveHash;
    my %AppHash;
    while (my ($setting,$type) = each(%$Settings)) {
        my $basename = join('.','internal',$context,$prefix,$setting);
        my $envname = 'environment.'.$basename;
        if (exists($env{'form.'.$setting})) {
            # Save this value away
            if ($type eq 'scalar' &&
                (! exists($env{$envname}) || 
                 $env{$envname} ne $env{'form.'.$setting})) {
                $SaveHash{$basename} = $env{'form.'.$setting};
                $AppHash{$envname}   = $env{'form.'.$setting};
            } elsif ($type eq 'array') {
                my $stored_form;
                if (ref($env{'form.'.$setting})) {
                    $stored_form = join(',',
                                        map {
                                            &escape($_);
                                        } sort(@{$env{'form.'.$setting}}));
                } else {
                    $stored_form = 
                        &escape($env{'form.'.$setting});
                }
                # Determine if the array contents are the same.
                if ($stored_form ne $env{$envname}) {
                    $SaveHash{$basename} = $stored_form;
                    $AppHash{$envname}   = $stored_form;
                }
            }
        }
    }
    my $put_result = &Apache::lonnet::put('environment',\%SaveHash,
                                          $udom,$uname);
    if ($put_result !~ /^(ok|delayed)/) {
        &Apache::lonnet::logthis('unable to save form parameters, '.
                                 'got error:'.$put_result);
    }
    # Make sure these settings stick around in this session, too
    &Apache::lonnet::appenv(\%AppHash);
    return;
}

sub restore_course_settings {
    return &restore_settings($env{'request.course.id'},@_);
}

sub restore_settings {
    my ($context,$prefix,$Settings) = @_;
    while (my ($setting,$type) = each(%$Settings)) {
        next if (exists($env{'form.'.$setting}));
        my $envname = 'environment.internal.'.$context.'.'.$prefix.
            '.'.$setting;
        if (exists($env{$envname})) {
            if ($type eq 'scalar') {
                $env{'form.'.$setting} = $env{$envname};
            } elsif ($type eq 'array') {
                $env{'form.'.$setting} = [ 
                                           map { 
                                               &unescape($_); 
                                           } split(',',$env{$envname})
                                           ];
            }
        }
    }
}

#######################################################
#######################################################

=pod

=head1 Domain E-mail Routines  

=over 4

=item * &build_recipient_list()

Build recipient lists for five types of e-mail:
(a) Error Reports, (b) Package Updates, (c) lonstatus warnings/errors
(d) Help requests, (e) Course requests needing approval,  generated by
lonerrorhandler.pm, CHECKRPMS, loncron, lonsupportreq.pm and
loncoursequeueadmin.pm respectively.

Inputs:
defmail (scalar - email address of default recipient), 
mailing type (scalar - errormail, packagesmail, or helpdeskmail), 
defdom (domain for which to retrieve configuration settings),
origmail (scalar - email address of recipient from loncapa.conf, 
i.e., predates configuration by DC via domainprefs.pm 

Returns: comma separated list of addresses to which to send e-mail.

=back

=cut

############################################################
############################################################
sub build_recipient_list {
    my ($defmail,$mailing,$defdom,$origmail) = @_;
    my @recipients;
    my $otheremails;
    my %domconfig =
         &Apache::lonnet::get_dom('configuration',['contacts'],$defdom);
    if (ref($domconfig{'contacts'}) eq 'HASH') {
        if (exists($domconfig{'contacts'}{$mailing})) {
            if (ref($domconfig{'contacts'}{$mailing}) eq 'HASH') {
                my @contacts = ('adminemail','supportemail');
                foreach my $item (@contacts) {
                    if ($domconfig{'contacts'}{$mailing}{$item}) {
                        my $addr = $domconfig{'contacts'}{$item}; 
                        if (!grep(/^\Q$addr\E$/,@recipients)) {
                            push(@recipients,$addr);
                        }
                    }
                    $otheremails = $domconfig{'contacts'}{$mailing}{'others'};
                }
            }
        } elsif ($origmail ne '') {
            push(@recipients,$origmail);
        }
    } elsif ($origmail ne '') {
        push(@recipients,$origmail);
    }
    if (defined($defmail)) {
        if ($defmail ne '') {
            push(@recipients,$defmail);
        }
    }
    if ($otheremails) {
        my @others;
        if ($otheremails =~ /,/) {
            @others = split(/,/,$otheremails);
        } else {
            push(@others,$otheremails);
        }
        foreach my $addr (@others) {
            if (!grep(/^\Q$addr\E$/,@recipients)) {
                push(@recipients,$addr);
            }
        }
    }
    my $recipientlist = join(',',@recipients); 
    return $recipientlist;
}

############################################################
############################################################

=pod

=head1 Course Catalog Routines

=over 4

=item * &gather_categories()

Converts category definitions - keys of categories hash stored in  
coursecategories in configuration.db on the primary library server in a 
domain - to an array.  Also generates javascript and idx hash used to 
generate Domain Coordinator interface for editing Course Categories.

Inputs:

categories (reference to hash of category definitions).

cats (reference to array of arrays/hashes which encapsulates hierarchy of
      categories and subcategories).

idx (reference to hash of counters used in Domain Coordinator interface for 
      editing Course Categories).

jsarray (reference to array of categories used to create Javascript arrays for
         Domain Coordinator interface for editing Course Categories).

Returns: nothing

Side effects: populates cats, idx and jsarray. 

=cut

sub gather_categories {
    my ($categories,$cats,$idx,$jsarray) = @_;
    my %counters;
    my $num = 0;
    foreach my $item (keys(%{$categories})) {
        my ($cat,$container,$depth) = map { &unescape($_); } split(/:/,$item);
        if ($container eq '' && $depth == 0) {
            $cats->[$depth][$categories->{$item}] = $cat;
        } else {
            $cats->[$depth]{$container}[$categories->{$item}] = $cat;
        }
        my ($escitem,$tail) = split(/:/,$item,2);
        if ($counters{$tail} eq '') {
            $counters{$tail} = $num;
            $num ++;
        }
        if (ref($idx) eq 'HASH') {
            $idx->{$item} = $counters{$tail};
        }
        if (ref($jsarray) eq 'ARRAY') {
            push(@{$jsarray->[$counters{$tail}]},$item);
        }
    }
    return;
}

=pod

=item * &extract_categories()

Used to generate breadcrumb trails for course categories.

Inputs:

categories (reference to hash of category definitions).

cats (reference to array of arrays/hashes which encapsulates hierarchy of
      categories and subcategories).

trails (reference to array of breacrumb trails for each category).

allitems (reference to hash - key is category key 
         (format: escaped(name):escaped(parent category):depth in hierarchy).

idx (reference to hash of counters used in Domain Coordinator interface for
      editing Course Categories).

jsarray (reference to array of categories used to create Javascript arrays for
         Domain Coordinator interface for editing Course Categories).

subcats (reference to hash of arrays containing all subcategories within each 
         category, -recursive)

Returns: nothing

Side effects: populates trails and allitems hash references.

=cut

sub extract_categories {
    my ($categories,$cats,$trails,$allitems,$idx,$jsarray,$subcats) = @_;
    if (ref($categories) eq 'HASH') {
        &gather_categories($categories,$cats,$idx,$jsarray);
        if (ref($cats->[0]) eq 'ARRAY') {
            for (my $i=0; $i<@{$cats->[0]}; $i++) {
                my $name = $cats->[0][$i];
                my $item = &escape($name).'::0';
                my $trailstr;
                if ($name eq 'instcode') {
                    $trailstr = &mt('Official courses (with institutional codes)');
                } elsif ($name eq 'communities') {
                    $trailstr = &mt('Communities');
                } else {
                    $trailstr = $name;
                }
                if ($allitems->{$item} eq '') {
                    push(@{$trails},$trailstr);
                    $allitems->{$item} = scalar(@{$trails})-1;
                }
                my @parents = ($name);
                if (ref($cats->[1]{$name}) eq 'ARRAY') {
                    for (my $j=0; $j<@{$cats->[1]{$name}}; $j++) {
                        my $category = $cats->[1]{$name}[$j];
                        if (ref($subcats) eq 'HASH') {
                            push(@{$subcats->{$item}},&escape($category).':'.&escape($name).':1');
                        }
                        &recurse_categories($cats,2,$category,$trails,$allitems,\@parents,$subcats);
                    }
                } else {
                    if (ref($subcats) eq 'HASH') {
                        $subcats->{$item} = [];
                    }
                }
            }
        }
    }
    return;
}

=pod

=item *&recurse_categories()

Recursively used to generate breadcrumb trails for course categories.

Inputs:

cats (reference to array of arrays/hashes which encapsulates hierarchy of
      categories and subcategories).

depth (current depth in hierarchy of categories and sub-categories - 0 indexed).

category (current course category, for which breadcrumb trail is being generated).

trails (reference to array of breadcrumb trails for each category).

allitems (reference to hash - key is category key
         (format: escaped(name):escaped(parent category):depth in hierarchy).

parents (array containing containers directories for current category, 
         back to top level). 

Returns: nothing

Side effects: populates trails and allitems hash references

=cut

sub recurse_categories {
    my ($cats,$depth,$category,$trails,$allitems,$parents,$subcats) = @_;
    my $shallower = $depth - 1;
    if (ref($cats->[$depth]{$category}) eq 'ARRAY') {
        for (my $k=0; $k<@{$cats->[$depth]{$category}}; $k++) {
            my $name = $cats->[$depth]{$category}[$k];
            my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
            my $trailstr = join(' -&gt; ',(@{$parents},$category));
            if ($allitems->{$item} eq '') {
                push(@{$trails},$trailstr);
                $allitems->{$item} = scalar(@{$trails})-1;
            }
            my $deeper = $depth+1;
            push(@{$parents},$category);
            if (ref($subcats) eq 'HASH') {
                my $subcat = &escape($name).':'.$category.':'.$depth;
                for (my $j=@{$parents}; $j>=0; $j--) {
                    my $higher;
                    if ($j > 0) {
                        $higher = &escape($parents->[$j]).':'.
                                  &escape($parents->[$j-1]).':'.$j;
                    } else {
                        $higher = &escape($parents->[$j]).'::'.$j;
                    }
                    push(@{$subcats->{$higher}},$subcat);
                }
            }
            &recurse_categories($cats,$deeper,$name,$trails,$allitems,$parents,
                                $subcats);
            pop(@{$parents});
        }
    } else {
        my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
        my $trailstr = join(' -&gt; ',(@{$parents},$category));
        if ($allitems->{$item} eq '') {
            push(@{$trails},$trailstr);
            $allitems->{$item} = scalar(@{$trails})-1;
        }
    }
    return;
}

=pod

=item *&assign_categories_table()

Create a datatable for display of hierarchical categories in a domain,
with checkboxes to allow a course to be categorized. 

Inputs:

cathash - reference to hash of categories defined for the domain (from
          configuration.db)

currcat - scalar with an & separated list of categories assigned to a course. 

type    - scalar contains course type (Course or Community).

Returns: $output (markup to be displayed) 

=cut

sub assign_categories_table {
    my ($cathash,$currcat,$type) = @_;
    my $output;
    if (ref($cathash) eq 'HASH') {
        my (@cats,@trails,%allitems,%idx,@jsarray,@path,$maxdepth);
        &extract_categories($cathash,\@cats,\@trails,\%allitems,\%idx,\@jsarray);
        $maxdepth = scalar(@cats);
        if (@cats > 0) {
            my $itemcount = 0;
            if (ref($cats[0]) eq 'ARRAY') {
                my @currcategories;
                if ($currcat ne '') {
                    @currcategories = split('&',$currcat);
                }
                my $table;
                for (my $i=0; $i<@{$cats[0]}; $i++) {
                    my $parent = $cats[0][$i];
                    next if ($parent eq 'instcode');
                    if ($type eq 'Community') {
                        next unless ($parent eq 'communities');
                    } else {
                        next if ($parent eq 'communities');
                    }
                    my $css_class = $itemcount%2?' class="LC_odd_row"':'';
                    my $item = &escape($parent).'::0';
                    my $checked = '';
                    if (@currcategories > 0) {
                        if (grep(/^\Q$item\E$/,@currcategories)) {
                            $checked = ' checked="checked"';
                        }
                    }
                    my $parent_title = $parent;
                    if ($parent eq 'communities') {
                        $parent_title = &mt('Communities');
                    }
                    $table .= '<tr '.$css_class.'><td><span class="LC_nobreak">'.
                              '<input type="checkbox" name="usecategory" value="'.
                              $item.'"'.$checked.' />'.$parent_title.'</span>'.
                              '<input type="hidden" name="catname" value="'.$parent.'" /></td>';
                    my $depth = 1;
                    push(@path,$parent);
                    $table .= &assign_category_rows($itemcount,\@cats,$depth,$parent,\@path,\@currcategories);
                    pop(@path);
                    $table .= '</tr><tr><td colspan="'.$maxdepth.'" class="LC_row_separator"></td></tr>';
                    $itemcount ++;
                }
                if ($itemcount) {
                    $output = &Apache::loncommon::start_data_table().
                              $table.
                              &Apache::loncommon::end_data_table();
                }
            }
        }
    }
    return $output;
}

=pod

=item *&assign_category_rows()

Create a datatable row for display of nested categories in a domain,
with checkboxes to allow a course to be categorized,called recursively.

Inputs:

itemcount - track row number for alternating colors

cats - reference to array of arrays/hashes which encapsulates hierarchy of
      categories and subcategories.

depth - current depth in hierarchy of categories and sub-categories - 0 indexed.

parent - parent of current category item

path - Array containing all categories back up through the hierarchy from the
       current category to the top level.

currcategories - reference to array of current categories assigned to the course

Returns: $output (markup to be displayed).

=cut

sub assign_category_rows {
    my ($itemcount,$cats,$depth,$parent,$path,$currcategories) = @_;
    my ($text,$name,$item,$chgstr);
    if (ref($cats) eq 'ARRAY') {
        my $maxdepth = scalar(@{$cats});
        if (ref($cats->[$depth]) eq 'HASH') {
            if (ref($cats->[$depth]{$parent}) eq 'ARRAY') {
                my $numchildren = @{$cats->[$depth]{$parent}};
                my $css_class = $itemcount%2?' class="LC_odd_row"':'';
                $text .= '<td><table class="LC_datatable">';
                for (my $j=0; $j<$numchildren; $j++) {
                    $name = $cats->[$depth]{$parent}[$j];
                    $item = &escape($name).':'.&escape($parent).':'.$depth;
                    my $deeper = $depth+1;
                    my $checked = '';
                    if (ref($currcategories) eq 'ARRAY') {
                        if (@{$currcategories} > 0) {
                            if (grep(/^\Q$item\E$/,@{$currcategories})) {
                                $checked = ' checked="checked"';
                            }
                        }
                    }
                    $text .= '<tr><td><span class="LC_nobreak"><label>'.
                             '<input type="checkbox" name="usecategory" value="'.
                             $item.'"'.$checked.' />'.$name.'</label></span>'.
                             '<input type="hidden" name="catname" value="'.$name.'" />'.
                             '</td><td>';
                    if (ref($path) eq 'ARRAY') {
                        push(@{$path},$name);
                        $text .= &assign_category_rows($itemcount,$cats,$deeper,$name,$path,$currcategories);
                        pop(@{$path});
                    }
                    $text .= '</td></tr>';
                }
                $text .= '</table></td>';
            }
        }
    }
    return $text;
}

############################################################
############################################################


sub commit_customrole {
    my ($udom,$uname,$url,$three,$four,$five,$start,$end,$context) = @_;
    my $output = &mt('Assigning custom role').' "'.$five.'" by '.$four.':'.$three.' in '.$url.
                         ($start?', '.&mt('starting').' '.localtime($start):'').
                         ($end?', ending '.localtime($end):'').': <b>'.
              &Apache::lonnet::assigncustomrole(
                 $udom,$uname,$url,$three,$four,$five,$end,$start,undef,undef,$context).
                 '</b><br />';
    return $output;
}

sub commit_standardrole {
    my ($udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;
    my ($output,$logmsg,$linefeed);
    if ($context eq 'auto') {
        $linefeed = "\n";
    } else {
        $linefeed = "<br />\n";
    }  
    if ($three eq 'st') {
        my $result = &commit_studentrole(\$logmsg,$udom,$uname,$url,$three,$start,$end,
                                         $one,$two,$sec,$context);
        if (($result =~ /^error/) || ($result eq 'not_in_class') || 
            ($result eq 'unknown_course') || ($result eq 'refused')) {
            $output = $logmsg.' '.&mt('Error: ').$result."\n"; 
        } else {
            $output = $logmsg.$linefeed.&mt('Assigning').' '.$three.' in '.$url.
               ($start?', '.&mt('starting').' '.localtime($start):'').
               ($end?', '.&mt('ending').' '.localtime($end):'').': ';
            if ($context eq 'auto') {
                $output .= $result.$linefeed.&mt('Add to classlist').': ok';
            } else {
               $output .= '<b>'.$result.'</b>'.$linefeed.
               &mt('Add to classlist').': <b>ok</b>';
            }
            $output .= $linefeed;
        }
    } else {
        $output = &mt('Assigning').' '.$three.' in '.$url.
               ($start?', '.&mt('starting').' '.localtime($start):'').
               ($end?', '.&mt('ending').' '.localtime($end):'').': ';
        my $result = &Apache::lonnet::assignrole($udom,$uname,$url,$three,$end,$start,'','',$context);
        if ($context eq 'auto') {
            $output .= $result.$linefeed;
        } else {
            $output .= '<b>'.$result.'</b>'.$linefeed;
        }
    }
    return $output;
}

sub commit_studentrole {
    my ($logmsg,$udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;
    my ($result,$linefeed,$oldsecurl,$newsecurl);
    if ($context eq 'auto') {
        $linefeed = "\n";
    } else {
        $linefeed = '<br />'."\n";
    }
    if (defined($one) && defined($two)) {
        my $cid=$one.'_'.$two;
        my $oldsec=&Apache::lonnet::getsection($udom,$uname,$cid);
        my $secchange = 0;
        my $expire_role_result;
        my $modify_section_result;
        if ($oldsec ne '-1') { 
            if ($oldsec ne $sec) {
                $secchange = 1;
                my $now = time;
                my $uurl='/'.$cid;
                $uurl=~s/\_/\//g;
                if ($oldsec) {
                    $uurl.='/'.$oldsec;
                }
                $oldsecurl = $uurl;
                $expire_role_result = 
                    &Apache::lonnet::assignrole($udom,$uname,$uurl,'st',$now,'','',$context);
                if ($env{'request.course.sec'} ne '') { 
                    if ($expire_role_result eq 'refused') {
                        my @roles = ('st');
                        my @statuses = ('previous');
                        my @roledoms = ($one);
                        my $withsec = 1;
                        my %roleshash = 
                            &Apache::lonnet::get_my_roles($uname,$udom,'userroles',
                                              \@statuses,\@roles,\@roledoms,$withsec);
                        if (defined ($roleshash{$two.':'.$one.':st:'.$oldsec})) {
                            my ($oldstart,$oldend) = 
                                split(':',$roleshash{$two.':'.$one.':st:'.$oldsec});
                            if ($oldend > 0 && $oldend <= $now) {
                                $expire_role_result = 'ok';
                            }
                        }
                    }
                }
                $result = $expire_role_result;
            }
        }
        if (($expire_role_result eq 'ok') || ($secchange == 0)) {
            $modify_section_result = &Apache::lonnet::modify_student_enrollment($udom,$uname,undef,undef,undef,undef,undef,$sec,$end,$start,'','',$cid,'',$context);
            if ($modify_section_result =~ /^ok/) {
                if ($secchange == 1) {
                    if ($sec eq '') {
                        $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to student role without a section.',$uname,$oldsec).$linefeed;
                    } else {
                        $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to new section: [_3].',$uname,$oldsec,$sec).$linefeed;
                    }
                } elsif ($oldsec eq '-1') {
                    if ($sec eq '') {
                        $$logmsg .= &mt('New student role without a section for [_1] in course [_2].',$uname,$cid).$linefeed;
                    } else {
                        $$logmsg .= &mt('New student role for [_1] in section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
                    }
                } else {
                    if ($sec eq '') {
                        $$logmsg .= &mt('Student [_1] assigned to course [_2] without a section.',$uname,$cid).$linefeed;
                    } else {
                        $$logmsg .= &mt('Student [_1] assigned to section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
                    }
                }
            } else {
                if ($secchange) {       
                    $$logmsg .= &mt('Error when attempting section change for [_1] from old section "[_2]" to new section: "[_3]" in course [_4] -error:',$uname,$oldsec,$sec,$cid).' '.$modify_section_result.$linefeed;
                } else {
                    $$logmsg .= &mt('Error when attempting to modify role for [_1] for section: "[_2]" in course [_3] -error:',$uname,$sec,$cid).' '.$modify_section_result.$linefeed;
                }
            }
            $result = $modify_section_result;
        } elsif ($secchange == 1) {
            if ($oldsec eq '') {
                $$logmsg .= &mt('Error when attempting to expire existing role without a section for [_1] in course [_3] -error: ',$uname,$cid).' '.$expire_role_result.$linefeed;
            } else {
                $$logmsg .= &mt('Error when attempting to expire existing role for [_1] in section [_2] in course [_3] -error: ',$uname,$oldsec,$cid).' '.$expire_role_result.$linefeed;
            }
            if ($expire_role_result eq 'refused') {
                my $newsecurl = '/'.$cid;
                $newsecurl =~ s/\_/\//g;
                if ($sec ne '') {
                    $newsecurl.='/'.$sec;
                }
                if (&Apache::lonnet::allowed('cst',$newsecurl) && !(&Apache::lonnet::allowed('cst',$oldsecurl))) {
                    if ($sec eq '') {
                        $$logmsg .= &mt('Although your current role has privileges to add students to section "[_1]", you do not have privileges to modify existing enrollments unaffiliated with any section.',$sec).$linefeed;
                    } else {
                        $$logmsg .= &mt('Although your current role has privileges to add students to section "[_1]", you do not have privileges to modify existing enrollments in other sections.',$sec).$linefeed;
                    }
                }
            }
        }
    } else {
        $$logmsg .= &mt('Incomplete course id defined.').$linefeed.&mt('Addition of user [_1] from domain [_2] to course [_3], section [_4] not completed.',$uname,$udom,$one.'_'.$two,$sec).$linefeed;
        $result = "error: incomplete course id\n";
    }
    return $result;
}

############################################################
############################################################

sub check_clone {
    my ($args,$linefeed) = @_;
    my $cloneid='/'.$args->{'clonedomain'}.'/'.$args->{'clonecourse'};
    my ($clonecrsudom,$clonecrsunum)= &LONCAPA::split_courseid($cloneid);
    my $clonehome=&Apache::lonnet::homeserver($clonecrsunum,$clonecrsudom);
    my $clonemsg;
    my $can_clone = 0;
    my $lctype = lc($args->{'crstype'});
    if ($lctype ne 'community') {
        $lctype = 'course';
    }
    if ($clonehome eq 'no_host') {
        if ($args->{'crstype'} eq 'Community') {
            $clonemsg = &mt('No new community created.').$linefeed.&mt('A new community could not be cloned from the specified original - [_1] - because it is a non-existent community.',$args->{'clonecourse'}.':'.$args->{'clonedomain'});
        } else {
            $clonemsg = &mt('No new course created.').$linefeed.&mt('A new course could not be cloned from the specified original - [_1] - because it is a non-existent course.',$args->{'clonecourse'}.':'.$args->{'clonedomain'});
        }     
    } else {
	my %clonedesc = &Apache::lonnet::coursedescription($cloneid,{'one_time' => 1});
        if ($args->{'crstype'} eq 'Community') {
            if ($clonedesc{'type'} ne 'Community') {
                 $clonemsg = &mt('No new community created.').$linefeed.&mt('A new community could not be cloned from the specified original - [_1] - because it is a course not a community.',$args->{'clonecourse'}.':'.$args->{'clonedomain'});
                return ($can_clone, $clonemsg, $cloneid, $clonehome);
            }
        }
	if (($env{'request.role.domain'} eq $args->{'clonedomain'}) && 
            (&Apache::lonnet::allowed('ccc',$env{'request.role.domain'}))) {
	    $can_clone = 1;
	} else {
	    my %clonehash = &Apache::lonnet::get('environment',['cloners'],
						 $args->{'clonedomain'},$args->{'clonecourse'});
	    my @cloners = split(/,/,$clonehash{'cloners'});
            if (grep(/^\*$/,@cloners)) {
                $can_clone = 1;
            } elsif (grep(/^\*\:\Q$args->{'ccdomain'}\E$/,@cloners)) {
                $can_clone = 1;
            } else {
                my $ccrole = 'cc';
                if ($args->{'crstype'} eq 'Community') {
                    $ccrole = 'co';
                }
	        my %roleshash =
		    &Apache::lonnet::get_my_roles($args->{'ccuname'},
					 $args->{'ccdomain'},
                                         'userroles',['active'],[$ccrole],
					 [$args->{'clonedomain'}]);
	        if (($roleshash{$args->{'clonecourse'}.':'.$args->{'clonedomain'}.':'.$ccrole}) || (grep(/^\Q$args->{'ccuname'}\E:\Q$args->{'ccdomain'}\E$/,@cloners))) {
                    $can_clone = 1;
                } elsif (&Apache::lonnet::is_course_owner($args->{'clonedomain'},$args->{'clonecourse'},$args->{'ccuname'},$args->{'ccdomain'})) {
                    $can_clone = 1;
                } else {
                    if ($args->{'crstype'} eq 'Community') {
                        $clonemsg = &mt('No new community created.').$linefeed.&mt('The new community could not be cloned from the existing community because the new community owner ([_1]) does not have cloning rights in the existing community ([_2]).',$args->{'ccuname'}.':'.$args->{'ccdomain'},$clonedesc{'description'});
                    } else {
                        $clonemsg = &mt('No new course created.').$linefeed.&mt('The new course could not be cloned from the existing course because the new course owner ([_1]) does not have cloning rights in the existing course ([_2]).',$args->{'ccuname'}.':'.$args->{'ccdomain'},$clonedesc{'description'});
                    }
	        }
	    }
        }
    }
    return ($can_clone, $clonemsg, $cloneid, $clonehome);
}

sub construct_course {
    my ($args,$logmsg,$courseid,$crsudom,$crsunum,$udom,$uname,$context,$cnum,$category) = @_;
    my $outcome;
    my $linefeed =  '<br />'."\n";
    if ($context eq 'auto') {
        $linefeed = "\n";
    }

#
# Are we cloning?
#
    my ($can_clone, $clonemsg, $cloneid, $clonehome);
    if (($args->{'clonecourse'}) && ($args->{'clonedomain'})) {
	($can_clone, $clonemsg, $cloneid, $clonehome) = &check_clone($args,$linefeed);
	if ($context ne 'auto') {
            if ($clonemsg ne '') {
	        $clonemsg = '<span class="LC_error">'.$clonemsg.'</span>';
            }
	}
	$outcome .= $clonemsg.$linefeed;

        if (!$can_clone) {
	    return (0,$outcome);
	}
    }

#
# Open course
#
    my $crstype = lc($args->{'crstype'});
    my %cenv=();
    $$courseid=&Apache::lonnet::createcourse($args->{'course_domain'},
                                             $args->{'cdescr'},
                                             $args->{'curl'},
                                             $args->{'course_home'},
                                             $args->{'nonstandard'},
                                             $args->{'crscode'},
                                             $args->{'ccuname'}.':'.
                                             $args->{'ccdomain'},
                                             $args->{'crstype'},
                                             $cnum,$context,$category);

    # Note: The testing routines depend on this being output; see 
    # Utils::Course. This needs to at least be output as a comment
    # if anyone ever decides to not show this, and Utils::Course::new
    # will need to be suitably modified.
    $outcome .= &mt('New LON-CAPA [_1] ID: [_2]',$crstype,$$courseid).$linefeed;
    if ($$courseid =~ /^error:/) {
        return (0,$outcome);
    }

#
# Check if created correctly
#
    ($$crsudom,$$crsunum)= &LONCAPA::split_courseid($$courseid);
    my $crsuhome=&Apache::lonnet::homeserver($$crsunum,$$crsudom);
    if ($crsuhome eq 'no_host') {
        $outcome .= &mt('Course creation failed, unrecognized course home server.').$linefeed;
        return (0,$outcome);
    }
    $outcome .= &mt('Created on').': '.$crsuhome.$linefeed;

#
# Do the cloning
#   
    if ($can_clone && $cloneid) {
	$clonemsg = &mt('Cloning [_1] from [_2]',$crstype,$clonehome);
	if ($context ne 'auto') {
	    $clonemsg = '<span class="LC_success">'.$clonemsg.'</span>';
	}
	$outcome .= $clonemsg.$linefeed;
	my %oldcenv=&Apache::lonnet::dump('environment',$$crsudom,$$crsunum);
# Copy all files
	&Apache::lonclonecourse::copycoursefiles($cloneid,$$courseid,$args->{'datemode'},$args->{'dateshift'});
# Restore URL
	$cenv{'url'}=$oldcenv{'url'};
# Restore title
	$cenv{'description'}=$oldcenv{'description'};
# Restore creation date, creator and creation context.
        $cenv{'internal.created'}=$oldcenv{'internal.created'};
        $cenv{'internal.creator'}=$oldcenv{'internal.creator'};
        $cenv{'internal.creationcontext'}=$oldcenv{'internal.creationcontext'};
# Mark as cloned
	$cenv{'clonedfrom'}=$cloneid;
# Need to clone grading mode
        my %newenv=&Apache::lonnet::get('environment',['grading'],$$crsudom,$$crsunum);
        $cenv{'grading'}=$newenv{'grading'};
# Do not clone these environment entries
        &Apache::lonnet::del('environment',
                  ['default_enrollment_start_date',
                   'default_enrollment_end_date',
                   'question.email',
                   'policy.email',
                   'comment.email',
                   'pch.users.denied',
                   'plc.users.denied',
                   'hidefromcat',
                   'categories'],
                   $$crsudom,$$crsunum);
    }

#
# Set environment (will override cloned, if existing)
#
    my @sections = ();
    my @xlists = ();
    if ($args->{'crstype'}) {
        $cenv{'type'}=$args->{'crstype'};
    }
    if ($args->{'crsid'}) {
        $cenv{'courseid'}=$args->{'crsid'};
    }
    if ($args->{'crscode'}) {
        $cenv{'internal.coursecode'}=$args->{'crscode'};
    }
    if ($args->{'crsquota'} ne '') {
        $cenv{'internal.coursequota'}=$args->{'crsquota'};
    } else {
        $cenv{'internal.coursequota'}=$args->{'crsquota'} = 20;
    }
    if ($args->{'ccuname'}) {
        $cenv{'internal.courseowner'} = $args->{'ccuname'}.
                                        ':'.$args->{'ccdomain'};
    } else {
        $cenv{'internal.courseowner'} = $args->{'curruser'};
    }
    my @badclasses = (); # Used to accumulate sections/crosslistings that did not pass classlist access check for course owner.
    if ($args->{'crssections'}) {
        $cenv{'internal.sectionnums'} = '';
        if ($args->{'crssections'} =~ m/,/) {
            @sections = split/,/,$args->{'crssections'};
        } else {
            $sections[0] = $args->{'crssections'};
        }
        if (@sections > 0) {
            foreach my $item (@sections) {
                my ($sec,$gp) = split/:/,$item;
                my $class = $args->{'crscode'}.$sec;
                my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$class,$cenv{'internal.courseowner'});
                $cenv{'internal.sectionnums'} .= $item.',';
                unless ($addcheck eq 'ok') {
                    push @badclasses, $class;
                }
            }
            $cenv{'internal.sectionnums'} =~ s/,$//;
        }
    }
# do not hide course coordinator from staff listing, 
# even if privileged
    $cenv{'nothideprivileged'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
# add crosslistings
    if ($args->{'crsxlist'}) {
        $cenv{'internal.crosslistings'}='';
        if ($args->{'crsxlist'} =~ m/,/) {
            @xlists = split/,/,$args->{'crsxlist'};
        } else {
            $xlists[0] = $args->{'crsxlist'};
        }
        if (@xlists > 0) {
            foreach my $item (@xlists) {
                my ($xl,$gp) = split/:/,$item;
                my $addcheck =  &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$xl,$cenv{'internal.courseowner'});
                $cenv{'internal.crosslistings'} .= $item.',';
                unless ($addcheck eq 'ok') {
                    push @badclasses, $xl;
                }
            }
            $cenv{'internal.crosslistings'} =~ s/,$//;
        }
    }
    if ($args->{'autoadds'}) {
        $cenv{'internal.autoadds'}=$args->{'autoadds'};
    }
    if ($args->{'autodrops'}) {
        $cenv{'internal.autodrops'}=$args->{'autodrops'};
    }
# check for notification of enrollment changes
    my @notified = ();
    if ($args->{'notify_owner'}) {
        if ($args->{'ccuname'} ne '') {
            push(@notified,$args->{'ccuname'}.':'.$args->{'ccdomain'});
        }
    }
    if ($args->{'notify_dc'}) {
        if ($uname ne '') { 
            push(@notified,$uname.':'.$udom);
        }
    }
    if (@notified > 0) {
        my $notifylist;
        if (@notified > 1) {
            $notifylist = join(',',@notified);
        } else {
            $notifylist = $notified[0];
        }
        $cenv{'internal.notifylist'} = $notifylist;
    }
    if (@badclasses > 0) {
        my %lt=&Apache::lonlocal::texthash(
                'tclb' => 'The courses listed below were included as sections or crosslistings affiliated with your new LON-CAPA course.  However, if automated course roster updates are enabled for this class, these particular sections/crosslistings will not contribute towards enrollment, because the user identified as the course owner for this LON-CAPA course',
                'dnhr' => 'does not have rights to access enrollment in these classes',
                'adby' => 'as determined by the policies of your institution on access to official classlists'
        );
        my $badclass_msg = $cenv{'internal.courseowner'}.') - '.$lt{'dnhr'}.
                           ' ('.$lt{'adby'}.')';
        if ($context eq 'auto') {
            $outcome .= $badclass_msg.$linefeed;
            $outcome .= '<div class="LC_warning">'.$badclass_msg.$linefeed.'<ul>'."\n";
            foreach my $item (@badclasses) {
                if ($context eq 'auto') {
                    $outcome .= " - $item\n";
                } else {
                    $outcome .= "<li>$item</li>\n";
                }
            }
            if ($context eq 'auto') {
                $outcome .= $linefeed;
            } else {
                $outcome .= "</ul><br /><br /></div>\n";
            }
        } 
    }
    if ($args->{'no_end_date'}) {
        $args->{'endaccess'} = 0;
    }
    $cenv{'internal.autostart'}=$args->{'enrollstart'};
    $cenv{'internal.autoend'}=$args->{'enrollend'};
    $cenv{'default_enrollment_start_date'}=$args->{'startaccess'};
    $cenv{'default_enrollment_end_date'}=$args->{'endaccess'};
    if ($args->{'showphotos'}) {
      $cenv{'internal.showphotos'}=$args->{'showphotos'};
    }
    $cenv{'internal.authtype'} = $args->{'authtype'};
    $cenv{'internal.autharg'} = $args->{'autharg'}; 
    if ( ($cenv{'internal.authtype'} =~ /^krb/) && ($cenv{'internal.autoadds'} == 1)) {
        if (! defined($cenv{'internal.autharg'}) || $cenv{'internal.autharg'}  eq '') {
            my $krb_msg = &mt('As you did not include the default Kerberos domain to be used for authentication in this class, the institutional data used by the automated enrollment process must include the Kerberos domain for each new student'); 
            if ($context eq 'auto') {
                $outcome .= $krb_msg;
            } else {
                $outcome .= '<span class="LC_error">'.$krb_msg.'</span>';
            }
            $outcome .= $linefeed;
        }
    }
    if (($args->{'ccdomain'}) && ($args->{'ccuname'})) {
       if ($args->{'setpolicy'}) {
           $cenv{'policy.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
       }
       if ($args->{'setcontent'}) {
           $cenv{'question.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
       }
    }
    if ($args->{'reshome'}) {
	$cenv{'reshome'}=$args->{'reshome'}.'/';
	$cenv{'reshome'}=~s/\/+$/\//;
    }
#
# course has keyed access
#
    if ($args->{'setkeys'}) {
       $cenv{'keyaccess'}='yes';
    }
# if specified, key authority is not course, but user
# only active if keyaccess is yes
    if ($args->{'keyauth'}) {
	my ($user,$domain) = split(':',$args->{'keyauth'});
	$user = &LONCAPA::clean_username($user);
	$domain = &LONCAPA::clean_username($domain);
	if ($user ne '' && $domain ne '') {
	    $cenv{'keyauth'}=$user.':'.$domain;
	}
    }

    if ($args->{'disresdis'}) {
        $cenv{'pch.roles.denied'}='st';
    }
    if ($args->{'disablechat'}) {
        $cenv{'plc.roles.denied'}='st';
    }

    # Record we've not yet viewed the Course Initialization Helper for this 
    # course
    $cenv{'course.helper.not.run'} = 1;
    #
    # Use new Randomseed
    #
    $cenv{'rndseed'}=&Apache::lonnet::latest_rnd_algorithm_id();;
    $cenv{'receiptalg'}=&Apache::lonnet::latest_receipt_algorithm_id();;
    #
    # The encryption code and receipt prefix for this course
    #
    $cenv{'internal.encseed'}=$Apache::lonnet::perlvar{'lonReceipt'}.$$.time.int(rand(9999));
    $cenv{'internal.encpref'}=100+int(9*rand(99));
    #
    # By default, use standard grading
    if (!defined($cenv{'grading'})) { $cenv{'grading'} = 'standard'; }

    $outcome .= $linefeed.&mt('Setting environment').': '.                 
          &Apache::lonnet::put('environment',\%cenv,$$crsudom,$$crsunum).$linefeed;
#
# Open all assignments
#
    if ($args->{'openall'}) {
       my $storeunder=$$crsudom.'_'.$$crsunum.'.0.opendate';
       my %storecontent = ($storeunder         => time,
                           $storeunder.'.type' => 'date_start');
       
       $outcome .= &mt('Opening all assignments').': '.&Apache::lonnet::cput
                 ('resourcedata',\%storecontent,$$crsudom,$$crsunum).$linefeed;
   }
#
# Set first page
#
    unless (($args->{'nonstandard'}) || ($args->{'firstres'} eq 'blank')
	    || ($cloneid)) {
	use LONCAPA::map;
	$outcome .= &mt('Setting first resource').': ';

	my $map = '/uploaded/'.$$crsudom.'/'.$$crsunum.'/default.sequence';
        my ($errtext,$fatal)=&LONCAPA::map::mapread($map);

        $outcome .= ($fatal?$errtext:'read ok').' - ';
        my $title; my $url;
        if ($args->{'firstres'} eq 'syl') {
	    $title=&mt('Syllabus');
            $url='/public/'.$$crsudom.'/'.$$crsunum.'/syllabus';
        } else {
            $title=&mt('Table of Contents');
            $url='/adm/navmaps';
        }

        $LONCAPA::map::resources[1]=$title.':'.$url.':false:start:res';
	(my $outtext,$errtext) = &LONCAPA::map::storemap($map,1);

	if ($errtext) { $fatal=2; }
        $outcome .= ($fatal?$errtext:'write ok').$linefeed;
    }

    return (1,$outcome);
}

############################################################
############################################################

#SD
# only Community and Course, or anything else?
sub course_type {
    my ($cid) = @_;
    if (!defined($cid)) {
        $cid = $env{'request.course.id'};
    }
    if (defined($env{'course.'.$cid.'.type'})) {
        return $env{'course.'.$cid.'.type'};
    } else {
        return 'Course';
    }
}

sub group_term {
    my $crstype = &course_type();
    my %names = (
                  'Course' => 'group',
                  'Community' => 'group',
                );
    return $names{$crstype};
}

sub course_types {
    my @types = ('official','unofficial','community');
    my %typename = (
                         official   => 'Official course',
                         unofficial => 'Unofficial course',
                         community  => 'Community',
                   );
    return (\@types,\%typename);
}

sub icon {
    my ($file)=@_;
    my $curfext = lc((split(/\./,$file))[-1]);
    my $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/unknown.gif';
    my $embstyle = &Apache::loncommon::fileembstyle($curfext);
    if (!(!defined($embstyle) || $embstyle eq 'unk' || $embstyle eq 'hdn')) {
	if (-e  $Apache::lonnet::perlvar{'lonDocRoot'}.'/'.
	          $Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
	            $curfext.".gif") {
	    $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
		$curfext.".gif";
	}
    }
    return &lonhttpdurl($iconname);
} 

sub lonhttpdurl {
#
# Had been used for "small fry" static images on separate port 8080.
# Modify here if lightweight http functionality desired again.
# Currently eliminated due to increasing firewall issues.
#
    my ($url)=@_;
    return $url;
}

sub connection_aborted {
    my ($r)=@_;
    $r->print(" ");$r->rflush();
    my $c = $r->connection;
    return $c->aborted();
}

#    Escapes strings that may have embedded 's that will be put into
#    strings as 'strings'.
sub escape_single {
    my ($input) = @_;
    $input =~ s/\\/\\\\/g;	# Escape the \'s..(must be first)>
    $input =~ s/\'/\\\'/g;	# Esacpe the 's....
    return $input;
}

#  Same as escape_single, but escape's "'s  This 
#  can be used for  "strings"
sub escape_double {
    my ($input) = @_;
    $input =~ s/\\/\\\\/g;	# Escape the /'s..(must be first)>
    $input =~ s/\"/\\\"/g;	# Esacpe the "s....
    return $input;
}
 
#   Escapes the last element of a full URL.
sub escape_url {
    my ($url)   = @_;
    my @urlslices = split(/\//, $url,-1);
    my $lastitem = &escape(pop(@urlslices));
    return join('/',@urlslices).'/'.$lastitem;
}

sub compare_arrays {
    my ($arrayref1,$arrayref2) = @_;
    my (@difference,%count);
    @difference = ();
    %count = ();
    if ((ref($arrayref1) eq 'ARRAY') && (ref($arrayref2) eq 'ARRAY')) {
        foreach my $element (@{$arrayref1}, @{$arrayref2}) { $count{$element}++; }
        foreach my $element (keys(%count)) {
            if ($count{$element} == 1) {
                push(@difference,$element);
            }
        }
    }
    return @difference;
}

# -------------------------------------------------------- Initialize user login
sub init_user_environment {
    my ($r, $username, $domain, $authhost, $form, $args) = @_;
    my $lonids=$Apache::lonnet::perlvar{'lonIDsDir'};

    my $public=($username eq 'public' && $domain eq 'public');

# See if old ID present, if so, remove

    my ($filename,$cookie,$userroles);
    my $now=time;

    if ($public) {
	my $max_public=100;
	my $oldest;
	my $oldest_time=0;
	for(my $next=1;$next<=$max_public;$next++) {
	    if (-e $lonids."/publicuser_$next.id") {
		my $mtime=(stat($lonids."/publicuser_$next.id"))[9];
		if ($mtime<$oldest_time || !$oldest_time) {
		    $oldest_time=$mtime;
		    $oldest=$next;
		}
	    } else {
		$cookie="publicuser_$next";
		last;
	    }
	}
	if (!$cookie) { $cookie="publicuser_$oldest"; }
    } else {
	# if this isn't a robot, kill any existing non-robot sessions
	if (!$args->{'robot'}) {
	    opendir(DIR,$lonids);
	    while ($filename=readdir(DIR)) {
		if ($filename=~/^$username\_\d+\_$domain\_$authhost\.id$/) {
		    unlink($lonids.'/'.$filename);
		}
	    }
	    closedir(DIR);
	}
# Give them a new cookie
	my $id = ($args->{'robot'} ? 'robot'.$args->{'robot'}
		                   : $now.$$.int(rand(10000)));
	$cookie="$username\_$id\_$domain\_$authhost";
    
# Initialize roles

	$userroles=&Apache::lonnet::rolesinit($domain,$username,$authhost);
    }
# ------------------------------------ Check browser type and MathML capability

    my ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
        $clientunicode,$clientos) = &decode_user_agent($r);

# ------------------------------------------------------------- Get environment

    my %userenv = &Apache::lonnet::dump('environment',$domain,$username);
    my ($tmp) = keys(%userenv);
    if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
    } else {
	undef(%userenv);
    }
    if (($userenv{'interface'}) && (!$form->{'interface'})) {
	$form->{'interface'}=$userenv{'interface'};
    }
    if ($userenv{'texengine'} eq 'ttm') { $clientmathml=1; }

# --------------- Do not trust query string to be put directly into environment
    foreach my $option ('interface','localpath','localres') {
        $form->{$option}=~s/[\n\r\=]//gs;
    }
# --------------------------------------------------------- Write first profile

    {
	my %initial_env = 
	    ("user.name"          => $username,
	     "user.domain"        => $domain,
	     "user.home"          => $authhost,
	     "browser.type"       => $clientbrowser,
	     "browser.version"    => $clientversion,
	     "browser.mathml"     => $clientmathml,
	     "browser.unicode"    => $clientunicode,
	     "browser.os"         => $clientos,
	     "server.domain"      => $Apache::lonnet::perlvar{'lonDefDomain'},
	     "request.course.fn"  => '',
	     "request.course.uri" => '',
	     "request.course.sec" => '',
	     "request.role"       => 'cm',
	     "request.role.adv"   => $env{'user.adv'},
	     "request.host"       => $ENV{'REMOTE_ADDR'},);

        if ($form->{'localpath'}) {
	    $initial_env{"browser.localpath"}  = $form->{'localpath'};
	    $initial_env{"browser.localres"}   = $form->{'localres'};
        }
	
	if ($form->{'interface'}) {
	    $form->{'interface'}=~s/\W//gs;
	    $initial_env{"browser.interface"} = $form->{'interface'};
	    $env{'browser.interface'}=$form->{'interface'};
	}

        my %is_adv = ( is_adv => $env{'user.adv'} );
        my %domdef = &Apache::lonnet::get_domain_defaults($domain);

        foreach my $tool ('aboutme','blog','portfolio') {
            $userenv{'availabletools.'.$tool} = 
                &Apache::lonnet::usertools_access($username,$domain,$tool,'reload',
                                                  undef,\%userenv,\%domdef,\%is_adv);
        }

        foreach my $crstype ('official','unofficial','community') {
            $userenv{'canrequest.'.$crstype} =
                &Apache::lonnet::usertools_access($username,$domain,$crstype,
                                                  'reload','requestcourses',
                                                  \%userenv,\%domdef,\%is_adv);
        }

	$env{'user.environment'} = "$lonids/$cookie.id";
	
	if (tie(my %disk_env,'GDBM_File',"$lonids/$cookie.id",
		 &GDBM_WRCREAT(),0640)) {
	    &_add_to_env(\%disk_env,\%initial_env);
	    &_add_to_env(\%disk_env,\%userenv,'environment.');
	    &_add_to_env(\%disk_env,$userroles);
	    if (ref($args->{'extra_env'})) {
		&_add_to_env(\%disk_env,$args->{'extra_env'});
	    }
	    untie(%disk_env);
	} else {
	    &Apache::lonnet::logthis("<span style=\"color:blue;\">WARNING: ".
			   'Could not create environment storage in lonauth: '.$!.'</span>');
	    return 'error: '.$!;
	}
    }
    $env{'request.role'}='cm';
    $env{'request.role.adv'}=$env{'user.adv'};
    $env{'browser.type'}=$clientbrowser;

    return $cookie;

}

sub _add_to_env {
    my ($idf,$env_data,$prefix) = @_;
    if (ref($env_data) eq 'HASH') {
        while (my ($key,$value) = each(%$env_data)) {
	    $idf->{$prefix.$key} = $value;
	    $env{$prefix.$key}   = $value;
        }
    }
}

# --- Get the symbolic name of a problem and the url
sub get_symb {
    my ($request,$silent) = @_;
    (my $url=$env{'form.url'}) =~ s-^https?\://($ENV{'SERVER_NAME'}|$ENV{'HTTP_HOST'})--;
    my $symb=($env{'form.symb'} ne '' ? $env{'form.symb'} : (&Apache::lonnet::symbread($url)));
    if ($symb eq '') {
        if (!$silent) {
            $request->print("Unable to handle ambiguous references:$url:.");
            return ();
        }
    }
    &Apache::lonenc::check_decrypt(\$symb);
    return ($symb);
}

# --------------------------------------------------------------Get annotation

sub get_annotation {
    my ($symb,$enc) = @_;

    my $key = $symb;
    if (!$enc) {
        $key =
            &Apache::lonnet::clutter((&Apache::lonnet::decode_symb($symb))[2]);
    }
    my %annotation=&Apache::lonnet::get('nohist_annotations',[$key]);
    return $annotation{$key};
}

sub clean_symb {
    my ($symb,$delete_enc) = @_;

    &Apache::lonenc::check_decrypt(\$symb);
    my $enc = $env{'request.enc'};
    if ($delete_enc) {
        delete($env{'request.enc'});
    }

    return ($symb,$enc);
}

=pod

=back

=cut

1;
__END__;


Index: modules/ehlerst/homescreen/lonfeedback.pm
+++ modules/ehlerst/homescreen/lonfeedback.pm
# The LearningOnline Network
# Feedback
#
# $Id: lonfeedback.pm,v 1.1 2011/03/19 15:47:12 ehlerst Exp $
#
# Copyright Michigan State University Board of Trustees
#
# This file is part of the LearningOnline Network with CAPA (LON-CAPA).
#
# LON-CAPA is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# LON-CAPA is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with LON-CAPA; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
#
# /home/httpd/html/adm/gpl.txt
#
# http://www.lon-capa.org/
#
###

package Apache::lonfeedback;

use strict;
use Apache::Constants qw(:common);
use Apache::lonmsg();
use Apache::loncommon();
use Apache::lontexconvert();
use Apache::lonlocal; # must not have ()
use Apache::lonnet;
use Apache::lonhtmlcommon();
use Apache::lonnavmaps;
use Apache::lonenc();
use Apache::lonrss();
use HTML::LCParser();
#use HTML::Tidy::libXML;
use Apache::lonspeller();
use Apache::longroup;
use Apache::lonfeeds();
use Cwd;
use LONCAPA;
use DateTime;

sub discussion_open {
    my ($status,$symb)=@_;
# Advanced roles can always discuss
    if ($env{'request.role.adv'}) { return 1; }
# Get discussion closing date
    my $close=&Apache::lonnet::EXT('resource.0.discussend',$symb);
# If it is defined and in the future, the instructor wants this discussion to be open
    if (defined($close) && $close ne '' && $close > time) {
        return 1;
    }
# It was not explicitly open, check if the problem is available.
# If the problem is not available, close the discussion 
    if (defined($status) &&
	!($status eq 'CAN_ANSWER' || $status eq 'CANNOT_ANSWER'
	  || $status eq 'OPEN')) {
	return 0;
    }
# The problem is available, but check if the instructor explictly closed discussion
    if (defined($close) && $close ne '' && $close < time) {
	return 0;
    }
    return 1;
}

sub discussion_visible {
    my ($status)=@_;
    if (not &discussion_open($status)) {
	my $hidden=&Apache::lonnet::EXT('resource.0.discusshide');
	if (lc($hidden) eq 'yes' or $hidden eq '' or !defined($hidden))  {
	    if (!$env{'request.role.adv'}) { return 0; }
	}
    }
    return 1;
}

sub list_discussion {
    my ($mode,$status,$ressymb,$imsextras,$group)=@_;
    unless ($ressymb) { $ressymb=&Apache::lonnet::symbread(); }
    unless ($ressymb) { return ''; }
    $ressymb=&wrap_symb($ressymb);
    my $outputtarget=$env{'form.grade_target'};
    if (defined($env{'form.export'})) {
	if($env{'form.export'}) {
            $outputtarget = 'export';
        }
    }
    if (defined($imsextras)) {
        if ($$imsextras{'caller'} eq 'imsexport') {
            $outputtarget = 'export';
        }
    }
    if (not &discussion_visible($status)) {
        if ($mode ne 'board') {
            &Apache::lonenc::check_encrypt(\$ressymb); 
            return '<br /><div class="LC_feedback_link">'.&send_message_link($ressymb)."</div>";
        }
    }
    if ($group ne '' && $mode eq 'board') {
        if (&check_group_priv($group,'vgb') ne 'ok') {
            return '';
        }
    }

    my ($blocked,$blocktext) = 
        &Apache::loncommon::blocking_status('boards');
    if ($blocked) {
        $blocktext = '<br /><div class="LC_feedback_link"><span class="LC_feedback_link">'.$blocktext."</span>";
        &Apache::lonenc::check_encrypt(\$ressymb);
        if ($mode ne 'board') {
            $blocktext.=&send_message_link($ressymb).'</div>';
        }else{
            $blocktext.="</div>";
        }
        return $blocktext; 
    }

    my @bgcols = ("LC_disc_old_item","LC_disc_new_item");
    my $discussiononly=0;
    if ($mode eq 'board') { $discussiononly=1; }
    unless ($env{'request.course.id'}) { return ''; }
    my $crs='/'.$env{'request.course.id'};
    my $cid=$env{'request.course.id'};
    if ($env{'request.course.sec'}) {
	$crs.='_'.$env{'request.course.sec'};
    }
    $crs=~s/\_/\//g;
    my $encsymb=&Apache::lonenc::check_encrypt($ressymb);
    my $viewgrades=(&Apache::lonnet::allowed('vgr',$crs)
		  && ($ressymb=~/\.(problem|exam|quiz|assess|survey|form|task)$/));
    
    my %usernamesort = ();
    my %namesort =();
    my %subjectsort = ();

# Get discussion display settings for this discussion
    my $lastkey = $ressymb.'_lastread';
    my $showkey = $ressymb.'_showonlyunread';
    my $markkey = $ressymb.'_showonlyunmark',
    my $visitkey = $ressymb.'_visit';
    my $ondispkey = $ressymb.'_markondisp';
    my $userpickkey = $ressymb.'_userpick';
    my $toggkey = $ressymb.'_readtoggle';
    my $readkey = $ressymb.'_read';
    $ressymb=$encsymb;
    my %dischash = &Apache::lonnet::get('nohist_'.$cid.'_discuss',[$lastkey,$showkey,$markkey,$visitkey,$ondispkey,$userpickkey,$toggkey,$readkey],$env{'user.domain'},$env{'user.name'});
    my %discinfo = ();
    my $showonlyunread = 0;
    my $showunmark = 0; 
    my $markondisp = 0;
    my $prevread = 0;
    my $previous = 0;
    my $visit = 0;
    my $newpostsflag = 0;
    my @posters = split(/\&/,$dischash{$userpickkey});

# Retain identification of "NEW" posts identified in last display, if continuing 'previous' browsing of posts.
    &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},['previous','sortposts','rolefilter','statusfilter','sectionpick','grouppick','totposters']);
    my $sortposts = $env{'form.sortposts'};
    my $statusfilter = $env{'form.statusfilter'};
    my @sectionpick = split(/,/,$env{'form.sectionpick'});
    my @grouppick   = split(/,/,$env{'form.grouppick'});
    my @rolefilter  = split(/,/,$env{'form.rolefilter'});

    my $totposters = $env{'form.totposters'};
    $previous = $env{'form.previous'};
    if ($previous > 0) {
        $prevread = $previous;
    } elsif (defined($dischash{$lastkey})) {
        unless ($dischash{$lastkey} eq '') {
            $prevread = $dischash{$lastkey};
        }
    }

    my $cdom = $env{'course.'.$cid.'.domain'};
    my $cnum = $env{'course.'.$cid.'.num'};
    my $crstype = &Apache::loncommon::course_type();

# Get information about students and non-students in course for filtering display of posts
    my %roleshash = ();
    my %roleinfo = ();
    my ($classgroups,$studentgroups);
    if ($env{'form.rolefilter'}) {
        %roleshash = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
        foreach my $rolekey (keys(%roleshash)) {
            my ($role,$uname,$udom,$sec) = split(/:/,$rolekey);
            if ($role =~ /^cr/) {
                $role = 'cr';
            }
            my ($end,$start) = split(/:/,$roleshash{$rolekey});
            my $now = time;
            my $status = 'Active';
            if (($now < $start) || ($end > 0 && $now > $end)) {
                $status = 'Expired';
            }
            if ($uname && $udom) { 
                push(@{$roleinfo{$uname.':'.$udom}}, $role.':'.$sec.':'.$status);
            }
        }
        my ($classlist,$keylist) =
                         &Apache::loncoursedata::get_classlist($cdom,$cnum);
        my $sec_index = &Apache::loncoursedata::CL_SECTION();
        my $status_index = &Apache::loncoursedata::CL_STATUS();
        while (my ($student,$data) = each %$classlist) {
            my ($section,$status) = ($data->[$sec_index],
                                 $data->[$status_index]);
            push(@{$roleinfo{$student}}, 'st:'.$section.':'.$status);
        }
	($classgroups,$studentgroups) = 
	    &Apache::loncoursedata::get_group_memberships($classlist,$keylist,
							  $cdom,$cnum);
    }

# Get discussion display default settings for user
    if ($env{'environment.discdisplay'} eq 'unread') {
        $showonlyunread = 1;
    }
    if ($env{'environment.discmarkread'} eq 'ondisp') {
        $markondisp = 1;
    }

# Override user's default if user specified display setting for this discussion
    if (defined($dischash{$ondispkey})) {
        unless ($dischash{$ondispkey} eq '') {
            $markondisp = $dischash{$ondispkey};
        }
    }
    if ($markondisp) {
        $discinfo{$lastkey} = time;
    }

    if (defined($dischash{$showkey})) {
        unless ($dischash{$showkey} eq '') {
            $showonlyunread = $dischash{$showkey};
        }
    }

    if (defined($dischash{$markkey})) {
        unless ($dischash{$markkey} eq '') {
            $showunmark = $dischash{$markkey};
        }
    }

    if (defined($dischash{$visitkey})) {
        unless ($dischash{$visitkey} eq '') {
            $visit = $dischash{$visitkey};
        }
    }
    $visit ++;

    my $seeid;
    if (($group ne '') && ($mode eq 'board') && 
        ($ressymb =~ m|^bulletin___\d+___adm/wrapper/adm/\Q$cdom\E/\Q$cnum\E/\d+/bulletinboard$|)) {
        if (&check_group_priv($group,'dgp') eq 'ok') {
            $seeid = 1;
        }
    } else {
        $seeid=&Apache::lonnet::allowed('rin',$crs);
    }
    my @discussionitems=();
    my %shown = ();
    my @posteridentity=();

    my $current=0;
    my $visible=0;
    my @depth=();
    my @replies = ();
    my %alldiscussion=();
    my %imsitems=();
    my %imsfiles=();
    my %notshown = ();
    my %newitem = ();
    my $maxdepth=0;
    my %anonhash=();
    my $anoncnt=0;
    my $target='';

    my $now = time;
    $discinfo{$visitkey} = $visit;

    &Apache::lonnet::put('nohist_'.$cid.'_discuss',\%discinfo,$env{'user.domain'},$env{'user.name'});
    &build_posting_display(\%usernamesort,\%subjectsort,\%namesort,\%notshown,\%newitem,\%dischash,\%shown,\%alldiscussion,\%imsitems,\%imsfiles,\%roleinfo,\@discussionitems,\@replies,\@depth,\@posters,\$maxdepth,\$visible,\$newpostsflag,\$current,$status,$viewgrades,$seeid,$prevread,$sortposts,$encsymb,$target,$readkey,$showunmark,$showonlyunread,$totposters,\@rolefilter,\@sectionpick,\@grouppick,$classgroups,$statusfilter,$toggkey,$outputtarget,\%anonhash,$anoncnt,$group);

    my $discussion='';
    my $manifestfile;
    my $manifestok=0;
    my $tempexport;
    my $imsresources;
    my $copyresult;

    my $function = &Apache::loncommon::get_users_function();
    my $color = &Apache::loncommon::designparm($function.'.tabbg',
                                                    $env{'user.domain'});
    my %lt = &Apache::lonlocal::texthash(
        'cuse' => 'Current discussion settings',
        'allposts' => 'All posts',
        'unread' => 'New posts only',
        'unmark' => 'Unread only',
        'ondisp' => 'Once displayed',
        'onmark' => 'Once marked not NEW',
        'toggoff' => 'Off',
        'toggon' => 'On',
        'disa' => 'Posts to be displayed',
        'npce' => 'Posts cease to be marked "NEW"',
        'epcb' => 'Each post can be toggled read/unread', 
        'chgt' => 'Change',
        'disp' => 'Display',
        'nolo' => 'Not new',
        'togg' => 'Toggle read/unread',
        'aner' => 'An error occurred opening the manifest file.',
        'difo' => 'Discussion for',
        'aerr' => 'An error occurred opening the export file for posting',
        'aysu' => 'Are you sure you want to delete this post?',
        'dpwn' => 'Deleted posts will no longer be visible to you and other students',
        'bwco' => 'but will continue to be visible to your instructor',
        'depo' => 'Deleted posts will no longer be visible to you or anyone else.',
        'discussions' => 'DISCUSSIONS'
    );

    my $currdisp = $lt{'allposts'};
    my $currmark = $lt{'onmark'};
    my $currtogg = $lt{'toggoff'};
    my $dispchange = $lt{'unread'};
    my $markchange = $lt{'ondisp'};
    my $toggchange = $lt{'toggon'};
    my $chglink = '/adm/feedback?modifydisp='.$ressymb;
    my $displinkA = 'onlyunread';
    my $displinkB = 'onlyunmark';
    my $marklink = 'markondisp';
    my $togglink = 'toggon';

    if ($markondisp) {
        $currmark = $lt{'ondisp'};
        $markchange = $lt{'onmark'};
        $marklink = 'markonread';
    }

    if ($showonlyunread) {
        $currdisp = $lt{'unread'};
        $dispchange = $lt{'allposts'};
        $displinkA = 'allposts';
    }

    if ($showunmark) {
        $currdisp = $lt{'unmark'};
        $dispchange = $lt{'unmark'};
        $displinkA='allposts';
        $displinkB='onlyunread';
        $showonlyunread = 0;
    }

    if ($dischash{$toggkey}) {
        $currtogg = $lt{'toggon'};
        $toggchange = $lt{'toggoff'};
        $togglink = 'toggoff';
    } 
   
    $chglink .= '&amp;changes='.$displinkA.'_'.$displinkB.'_'.$marklink.'_'.$togglink;

    if ($newpostsflag) {
        $chglink .= '&amp;previous='.$prevread;
    }
    $chglink.=&group_args($group);

    if ($visible) {
# Print the discusssion
        if ($outputtarget eq 'tex') {
            $discussion.='<tex>{\tiny \vskip 0 mm\noindent\makebox[2 cm][b]{\hrulefill}'.
                         '\textbf{'.$lt{'discussions'}.'}\makebox[2 cm][b]{\hrulefill}\vskip 0 mm'.
                         '\noindent\textbf{'.$lt{'disa'}.'}: \textit{'.$currdisp.'}\vskip 0 mm'.
                         '\noindent\textbf{'.$lt{'npce'}.'}: \textit{'.$currmark.'}}</tex>';
        } elsif ($outputtarget eq 'export') {
# Create temporary directory if this is an export
            my $now = time;
            if ((defined($imsextras)) && ($$imsextras{'caller'} eq 'imsexport')) {
                $tempexport = $$imsextras{'tempexport'};
                if (!-e $tempexport) {
                    mkdir($tempexport,0700);
                }
                $tempexport .= '/'.$$imsextras{'count'};
                if (!-e $tempexport) {
                    mkdir($tempexport,0700);
                }
            } else {
                $tempexport = $Apache::lonnet::perlvar{'lonDaemons'}.'/tmp/ims_exports';
                if (!-e $tempexport) {
                    mkdir($tempexport,0700);
                }
                $tempexport .= '/'.$now;
                if (!-e $tempexport) {
                    mkdir($tempexport,0700);
                }
                $tempexport .= '/'.$env{'user.domain'}.'_'.$env{'user.name'};
            }
            if (!-e $tempexport) {
                mkdir($tempexport,0700);
            }
# open manifest file
            my $manifest = '/imsmanifest.xml';
            my $manifestfilename = $tempexport.$manifest;
            if ($manifestfile = Apache::File->new('>'.$manifestfilename)) {
                $manifestok=1;
                print $manifestfile qq|<?xml version="1.0" encoding="UTF-8"?>
<manifest xmlns="http://www.imsglobal.org/xsd/imscp_v1p1" xmlns:imsmd="http://www.imsglobal.org/xsd/imsmd_v1p2" 
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
identifier="MANIFEST-$ressymb" xsi:schemaLocation="http://www.imsglobal.org/xsd/imscp_v1p1 
imscp_v1p1.xsd http://www.imsglobal.org/xsd/imsmd_v1p2 imsmd_v1p2p2.xsd">
  <organizations default="$ressymb">
    <organization identifier="$ressymb">
      <title>$lt{'difo'} $ressymb</title>\n|;
            } else {
                $discussion .= $lt{'aner'}.'<br />';
            }
	} else {
            my $colspan=$maxdepth+1;
            $discussion.= &Apache::lonhtmlcommon::scripttag(qq|
   function verifydelete (caller,symb,idx,newflag,previous,groupparm) {
       var symbparm = symb+':::'+idx
       var prevparm = ""
       if (newflag == 1) {
           prevparm = "&amp;previous="+previous
       }
       if (caller == 'studentdelete') {
           if (confirm("$lt{'aysu'}\\n$lt{'dpwn'},\\n$lt{'bwco'}")) {
               document.location.href = "/adm/feedback?hide="+symbparm+prevparm+groupparm
           }
       } else {
           if (caller == 'seeiddelete') {
               if (confirm("$lt{'aysu'}\\n$lt{'depo'}")) {
                   document.location.href = "/adm/feedback?deldisc="+symbparm+prevparm+groupparm
               }
           }
       }
   }
            |);
	    $discussion.='<form name="readchoices" method="post" action="/adm/feedback?chgreads='.$ressymb.'" >'.
                         "\n".'<table class="LC_discussion">';
            $discussion .= &action_links_bar($colspan,$ressymb,$visible,
                                             $newpostsflag,$group,
                                             $prevread,$markondisp);
            my $escsymb=&escape($ressymb);
            my $numhidden = keys(%notshown);
            if ($numhidden > 0) {
                my $colspan = $maxdepth+1;
                $discussion.="\n".'<tr><td bgcolor="#CCCCCC" colspan="'.$colspan.'">'.
                         '<a href="/adm/feedback?allposts=1&amp;symb='.$escsymb;
                if ($newpostsflag) {
                    $discussion .= '&amp;previous='.$prevread;
                }
		$discussion .= &group_args($group);
                $discussion .= '">'.&mt('Show all posts').'</a> '.&mt('to display').' '.
                         $numhidden.' ';
                if ($showunmark) {
                    $discussion .= &mt('posts previously marked read');
                } else {
                    $discussion .= &mt('previously viewed posts');
                }
                $discussion .= '<br/></td></tr>';
            }
        }

# Choose sort mechanism
        my @showposts = ();
        if ($sortposts eq 'descdate') {
            @showposts = (sort { $b <=> $a } keys(%alldiscussion));
        } elsif ($sortposts eq 'thread') {
            @showposts = (sort { $a <=> $b } keys(%alldiscussion));
        } elsif ($sortposts eq 'subject') {
            foreach my $key (sort(keys(%subjectsort))) {
                push(@showposts, @{$subjectsort{$key}});
            }
        } elsif ($sortposts eq 'username') {
            foreach my $domain (sort(keys(%usernamesort))) {
                foreach my $key (sort(keys(%{$usernamesort{$domain}}))) {
                    push(@showposts, @{$usernamesort{$domain}{$key}});
                }
            }
        } elsif ($sortposts eq 'lastfirst') {
            foreach my $last (sort(keys(%namesort))) {
                 foreach my $key (sort(keys(%{$namesort{$last}}))) {
                     push(@showposts, @{$namesort{$last}{$key}});
                 }
            }
        } else {
            @showposts =  (sort { $a <=> $b } keys(%alldiscussion));
        }
        my $currdepth = 0;
        my $firstidx = $alldiscussion{$showposts[0]};
        foreach my $post (@showposts) {
            unless (($sortposts eq 'thread') || (($sortposts eq '') && ($env{'environment.threadeddiscussion'})) || ($outputtarget eq 'export')) {
                $alldiscussion{$post} = $post;
            }
            unless ( ($notshown{$alldiscussion{$post}} eq '1') || ($shown{$alldiscussion{$post}} == 0) ) {
                if ($outputtarget ne 'tex' && $outputtarget ne 'export') {
		    $discussion.="\n<tr>";
		}
	        my $thisdepth=$depth[$alldiscussion{$post}];
                if ($outputtarget ne 'tex' && $outputtarget ne 'export') {
		    for (1..$thisdepth) {
			$discussion.='<td>&nbsp;&nbsp;&nbsp;</td>';
		    }
		}
	        my $colspan=$maxdepth-$thisdepth+1;
                if ($outputtarget eq 'tex') {
		    #cleanup block
		    $discussionitems[$alldiscussion{$post}]=~s/<table([^>]*)>/<table TeXwidth="90 mm">/;
		    $discussionitems[$alldiscussion{$post}]=~s/<tr([^>]*)><td([^>]*)>/<tr><td TeXwidth="20 mm" align="left">/;
                    my $threadinsert='';
                    if ($thisdepth > 0) {
			$threadinsert='<br /><strong>Reply: '.$thisdepth.'</strong>';
		    }
		    $discussionitems[$alldiscussion{$post}]=~s/<\/td><td([^>]*)>/$threadinsert<\/td><td TeXwidth="65 mm" align="left">/;
                    $discussionitems[$alldiscussion{$post}]=~s/(<b>|<\/b>|<\/a>|<a([^>]+)>)//g;

		    $discussionitems[$alldiscussion{$post}]='<tex>\vskip 0 mm\noindent\makebox[2 cm][b]{\hrulefill}</tex>'.$discussionitems[$alldiscussion{$post}];
		    $discussion.=$discussionitems[$alldiscussion{$post}];
		} elsif ($outputtarget eq 'export') {
                    my $postfilename = $alldiscussion{$post}.'-'.$imsitems{$alldiscussion{$post}}{'timestamp'}.'.html';
                    if ($manifestok) {
                        if (($depth[$alldiscussion{$post}] <= $currdepth) && ($alldiscussion{$post} != $firstidx)) {
                            print $manifestfile '  </item>'."\n";
                        }
                        $currdepth = $depth[$alldiscussion{$post}];
                        print $manifestfile "\n". 
      '<item identifier="ITEM-'.$ressymb.'-'.$alldiscussion{$post}.'" isvisible="'.
        $imsitems{$alldiscussion{$post}}{'isvisible'}.'" identifieref="RES-'.$ressymb.'-'.$alldiscussion{$post}.'">'.
        '<title>'.$imsitems{$alldiscussion{$post}}{'title'}.'</title></item>';
                        $imsresources .= "\n".
    '<resource identifier="RES-'.$ressymb.'-'.$alldiscussion{$post}.'" type="webcontent" href="'.$postfilename.'">'."\n".
      '<file href="'.$postfilename.'">'."\n".
      $imsfiles{$alldiscussion{$post}}{$imsitems{$alldiscussion{$post}}{'currversion'}}.'</file>'."\n".
    '</resource>';
                    }
                    my $postingfile;
                    my $postingfilename = $tempexport.'/'.$postfilename;
                    if ($postingfile = Apache::File->new('>'.$postingfilename)) {
                        print $postingfile '<html><head><title>Discussion Post</title></head><body>'.
                                           $imsitems{$alldiscussion{$post}}{'title'}.' '.
                                           $imsitems{$alldiscussion{$post}}{'sender'}.
                                           $imsitems{$alldiscussion{$post}}{'timestamp'}.'<br /><br />'.
                                           $imsitems{$alldiscussion{$post}}{'message'}.'<br />'.
                                           $imsitems{$alldiscussion{$post}}{'attach'}.'</body></html>'."\n"; 
                        close($postingfile);
                    } else {
                        $discussion .= $lt{'aerr'}.' '.$alldiscussion{$post}.'<br />';
                    }
                    $copyresult.=&replicate_attachments($imsitems{$alldiscussion{$post}}{'allattachments'},$tempexport);
                } else {
                    $discussion.='<td class="'.$bgcols[$newitem{$alldiscussion{$post}}].
                       '" colspan="'.$colspan.'">'. $discussionitems[$alldiscussion{$post}].
                       '</td></tr>';
                }
	    }
        }
	unless ($outputtarget eq 'tex' || $outputtarget eq 'export') {
            my $colspan=$maxdepth+1;
            $discussion .= <<END;
            <tr bgcolor="#FFFFFF">
             <td colspan="$colspan" class="LC_disc_action_links_bar">
              <table class="LC_disc_action_table">
               <tr>
                <td align="left">
                 <table border="0" cellpadding="0" cellspacing="4">
                  <tr>
                   <td>
                    <font size="-1"><b>$lt{'cuse'}</b>:</font></td>
                   <td>&nbsp;</td>
                   <td><font size="-1">
END
            if ($newpostsflag) {
                $discussion .= 
                   '1.&nbsp;'.$lt{'disp'}.'&nbsp;-&nbsp;<i>'.$currdisp.'</i>&nbsp;&nbsp;2.&nbsp;'.$lt{'nolo'}.'&nbsp;-&nbsp;<i>'.$currmark.'</i>';
                if ($dischash{$toggkey}) {
                   $discussion .= '&nbsp;&nbsp;3.&nbsp;'.$lt{'togg'}.'&nbsp;-&nbsp;<i>'.$currtogg.'</i>';
                }
            } else {
                if ($dischash{$toggkey}) {
                   $discussion .= '1.&nbsp;'.$lt{'disp'}.'&nbsp;-&nbsp;<i>'.$currdisp.'</i>&nbsp;2.&nbsp;'.$lt{'togg'}.'&nbsp;-&nbsp;<i>'.$currtogg.'</i>';
                } else {
                    $discussion .=
                         $lt{'disp'}.'&nbsp;-&nbsp;<i>'.$currdisp.'</i>';
                }
            }
            $discussion .= <<END;
                   </font></td>
                   <td>&nbsp;</td>
                   <td align="left">
                    <font size="-1"><b><a href="$chglink">$lt{'chgt'}</a>?</b></font>
                   </td>
                  </tr>
                 </table>
                </td>
END
            if ($sortposts) {
                my %sort_types = ();
                my %role_types = ();
                my %status_types = ();
                &sort_filter_names(\%sort_types,\%role_types,\%status_types,$crstype);

                $discussion .= '<td><font size="-1"><b>'.&mt('Sorted by').'</b>: '.$sort_types{$sortposts}.'<br />';
                if (defined($env{'form.totposters'})) {
                    $discussion .= &mt('Posts by').':';
                    if ($totposters > 0) {
                        foreach my $poster (@posters) {
                            $discussion .= ' '.$poster.',';
                        }
                        $discussion =~ s/,$//;
                    } else {
                        $discussion .= &mt('None selected');
                    }
                } else {
                    my $filterchoice ='';
                    if (@sectionpick > 0) {
                        $filterchoice = '<i>'.&mt('sections').'</i>-&nbsp;'.$env{'form.sectionpick'};
                        $filterchoice .= '&nbsp;&nbsp;&nbsp; ';
                    }
                    if (@grouppick > 0) {
                        $filterchoice = '<i>'.&mt('groups').'</i>-&nbsp;'.$env{'form.grouppick'};
                        $filterchoice .= '&nbsp;&nbsp;&nbsp; ';
                    }
                    if (@rolefilter > 0) {
                        $filterchoice .= '<i>'.&mt('roles').'</i>-';
                        foreach my $role (@rolefilter) {
                            $filterchoice .= '&nbsp;'.$role_types{$role}.',';
                        }
                        $filterchoice =~ s/,$//;
                        $filterchoice .= '<br />'.('&nbsp;' x8);
                    }
                    if ($statusfilter) {
                        $filterchoice .= '<i>'.&mt('status').'</i>-&nbsp;'.$status_types{$statusfilter};
                    }
                    if ($filterchoice) {
                        $discussion .= '<b>'.&mt('Filters').'</b>:&nbsp;'.$filterchoice;
                    }
                    $discussion .= '</font></td>';
                }
            }
            if ($dischash{$toggkey}) {
                my $storebutton = &mt('Save read/unread changes');
                $discussion.='<td align="right">'.
              '<input type="hidden" name="discsymb" value="'.$ressymb.'" />'."\n".
              '<input type="button" name="readoptions" value="'.$storebutton.'"'.
              ' onclick="this.form.submit();" />'."\n".
              '</td>';
            }
            $discussion .= (<<END);
               </tr>
              </table>
             </td>
            </tr>
END
            $discussion .= &action_links_bar($colspan,$ressymb,$visible,
                                             $newpostsflag,$group,
                                             $prevread,$markondisp);
            $discussion .= "
           </table>
           <br /><br /></form>\n";
        } 
        if ($outputtarget eq 'export') {
            if ($manifestok) {
                while ($currdepth > 0) {
                    print $manifestfile "    </item>\n";
                    $currdepth --;
                }
                print $manifestfile qq|
    </organization>
  </organizations>
  <resources>
    $imsresources
  </resources>
</manifest>
                |;
                close($manifestfile);
                if ((defined($imsextras)) && ($$imsextras{'caller'} eq 'imsexport')) {
                    $discussion = $copyresult;
                } else {

#Create zip file in prtspool

                    my $imszipfile = '/prtspool/'.
                    $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
                         time.'_'.rand(1000000000).'.zip';
                    my $cwd = &getcwd(); 
                    my $imszip = '/home/httpd/'.$imszipfile;
                    chdir $tempexport;
                    open(OUTPUT, "zip -r $imszip *  2> /dev/null |");
                    close(OUTPUT);
                    chdir $cwd;
                    $discussion .= &mt('Download the zip file from [_1]Discussion Posting Archive','<a href="'.$imszipfile.'">').'</a><br />';
                    if ($copyresult) {
                        $discussion .= &mt('The following errors occurred during export').' - <br />'.$copyresult;
                    }
                }
            } else {
                $discussion .= '<br />'.&mt('Unfortunately you will not be able to retrieve an archive of the discussion posts at this time, because there was a problem creating a manifest file.').'<br />';
            }
            return $discussion;
        }
    }
    if ($discussiononly) {
        my $now = time;
        my $attachnum = 0;
        my $currnewattach = [];
        my $currdelold = [];
        my $comment = '';
        my $subject = '';
        if ($env{'form.origpage'}) {
            &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},['addnewattach','deloldattach','delnewattach','timestamp','idx','subject','comment']);
            $subject = &unescape($env{'form.subject'});
            $comment = &unescape($env{'form.comment'});
            my @keepold = ();
            &process_attachments($currnewattach,$currdelold,\@keepold);
            if (@{$currnewattach} > 0) {
                $attachnum += @{$currnewattach};
            }
        }
	if ((&discussion_open($status)) && ($outputtarget ne 'tex')) {
            if (($group ne '') && ($mode eq 'board')) {  
                if ((&check_group_priv($group,'pgd') eq 'ok') && 
                   ($ressymb =~ m{^bulletin___\d+___adm/wrapper/adm/\Q$cdom\E/\Q$cnum\E/\d+/bulletinboard$})) {
                    $discussion .=
			&postingform_display($mode,$ressymb,$now,$subject,
					     $comment,$outputtarget,$attachnum,
					     $currnewattach,$currdelold,
					     $group,$crstype);
                }
            } else {
                if (&Apache::lonnet::allowed('pch',$env{'request.course.id'}.
                    ($env{'request.course.sec'}?'/'.$env{'request.course.sec'}:''))) {

	            $discussion.= 
		        &postingform_display($mode,$ressymb,$now,$subject,
					     $comment,$outputtarget,$attachnum,
					     $currnewattach,$currdelold,'',$crstype);
                } else {
                    $discussion.= '<span class="LC_feedback_link">'.
                                  &mt('This discussion is closed.').'</span>';
                }
            }
	}
        if (!(&discussion_open($status)) && ($outputtarget ne 'tex')) {
            $discussion.= '<span class="LC_feedback_link">'.
                          &mt('This discussion is closed.').'</span>';
        }
    } elsif ($outputtarget ne 'tex') {
        $discussion.='<div class="LC_feedback_link">';
        if (&discussion_open($status) &&
            &Apache::lonnet::allowed('pch',
    	        $env{'request.course.id'}.
	        ($env{'request.course.sec'}?'/'.$env{'request.course.sec'}:''))) {
            $discussion.= &send_feedback_link($ressymb,$target);
            if ($env{'request.role.adv'}) {
                my $close = &Apache::lonnet::EXT('resource.0.discussend',$ressymb);
                if (defined($close) && $close ne '' && $close < time) {
                    $discussion .= '&nbsp;'.&mt('(Closed for [_1] roles)',
                                                &Apache::lonnet::plaintext('st',$crstype));
                }
            }
	} else {
            $discussion.= '<span class="LC_feedback_link">'.&mt('This discussion is closed.').'</span>';
        }
	$discussion.= &send_message_link($ressymb).'</div>';
    }
    return $discussion;
}

sub send_feedback_link {
    my ($ressymb,$target) = @_;
    my $output = '<span class="LC_feedback_link">'.
                 ' <a href="/adm/feedback?replydisc='.
                 &escape($ressymb).':::" '.$target.'>'.
                 '<img alt="" class="LC_noBorder" src="'.
                 &Apache::loncommon::lonhttpdurl('/adm/lonMisc/chat.gif').
                 '" border="0" /><span class="LC_menubuttons_inline_text">'.&mt('Post Discussion').'</span></a></span>';
    return $output;
}

sub send_message_link {
    my ($ressymb) = @_;
    my $output = '<span class="LC_message_link">'.
                 '  <a href="/adm/feedback?sendmessageonly=1&amp;symb='.
                 &escape($ressymb).'"><img alt="" class="LC_noBorder" src="'.
                 &Apache::loncommon::lonhttpdurl('/res/adm/pages/feedback.png').
                 '" border="0" /><span class="LC_menubuttons_inline_text">'.&mt('Send Feedback').'</span></a></span>';
    return $output;
}

sub action_links_bar {
    my ($colspan,$ressymb,$visible,$newpostsflag,$group,$prevread,$markondisp) = @_;
    my $discussion = '<tr><td class="LC_disc_action_links_bar" colspan="'.$colspan.'">'.
                     '<table width="100%" class="LC_disc_action_table"><tr>'.
                     '<td class="LC_disc_action_left">';
    my $escsymb=&escape($ressymb);
    if ($visible) {
        $discussion .= '<a href="/adm/feedback?cmd=threadedon&amp;symb='.$escsymb;
        if ($newpostsflag) {
            $discussion .= '&amp;previous='.$prevread;
        }
        $discussion .= &group_args($group);
        $discussion .='">'.&mt('Threaded View').'</a>&nbsp;&nbsp;'.
                      '<a href="/adm/feedback?cmd=threadedoff&amp;symb='.$escsymb;
        if ($newpostsflag) {
            $discussion .= '&amp;previous='.$prevread;
        }
        $discussion .= &group_args($group);
        $discussion .='">'.&mt('Chronological View').'</a>&nbsp;&nbsp;
                       <a href="/adm/feedback?cmd=sortfilter&amp;symb='.$escsymb;
        if ($newpostsflag) {
            $discussion .= '&amp;previous='.$prevread;
        }
        $discussion .= &group_args($group);
        $discussion .='">'.&mt('Sorting/Filtering options').'</a>'.('&nbsp;' x2);
    }
    $discussion .='<a href="/adm/feedback?export='.$escsymb;
    if ($newpostsflag) {
        $discussion .= '&amp;previous='.$prevread;
    }
    $discussion .= &group_args($group);
    $discussion .= '">'.&mt('Export').'?</a>&nbsp;&nbsp;</td>';
    if ($newpostsflag) {
        if (!$markondisp) {
            $discussion .='<td class="LC_disc_action_right"><a href="/adm/preferences?action=changediscussions';
            $discussion .= &group_args($group);
            $discussion .= '">'.
                           &mt('Preferences on what is marked as NEW').
                           '</a><br /><a href="/adm/feedback?markread=1&amp;symb='.$escsymb;
            $discussion .= &group_args($group);
            $discussion .= '">'.&mt('Mark NEW posts no longer new').'</a></td>';
        } else {
            $discussion .= '<td>&nbsp;</td>';
        }
    } else {
        $discussion .= '<td>&nbsp;</td>';
    }
    $discussion .= '</tr></table></td></tr>';
    return $discussion;
}

sub postingform_display {
    my ($mode,$ressymb,$now,$subject,$comment,$outputtarget,$attachnum,
        $currnewattach,$currdelold,$group,$crstype) = @_;
    my $newattachmsg;
    my %lt = &Apache::lonlocal::texthash(
              'note' => 'Note: in anonymous discussion, your name is visible only to course faculty',
             'title' => 'Title',
             'podi' => 'Post Discussion',
             'poan' => 'Post Anonymous Discussion',
             'newa' => 'New attachments',
    );
    if ($crstype eq 'Community') {
        $lt{'note'} = &mt('Note: in anonymous discussion, your name is visible only to community facilitators');
    }
    my ($postingform,$textareaclass);
    if (&Apache::lonhtmlcommon::htmlareabrowser()) {
        $postingform = &Apache::lonhtmlcommon::htmlareaselectactive();
        $textareaclass = 'class="LC_richDefaultOff"';
        if ($env{'request.course.id'}) {
            unless (($env{'course.'.$env{'request.course.id'}.'.allow_limited_html_in_feedback'} =~ /^\s*yes\s*$/i) || ($env{'form.sendmessageonly'})) {
                undef($textareaclass);
            }
        }
    }
    $postingform .= (<<ENDDISCUSS);
<form action="/adm/feedback" method="post" name="mailform" enctype="multipart/form-data"> <input type="submit" name="discuss" value="$lt{'podi'}" />
<input type="submit" name="anondiscuss" value="$lt{'poan'}" /> <input type="hidden" name="symb" value="$ressymb" />
<input type="hidden" name="sendit" value="true" />
<input type="hidden" name="timestamp" value="$now" />
<br /><a name="newpost"></a>
<font size="1">$lt{'note'}</font><br />
<b>$lt{'title'}:</b>&nbsp;<input type="text" name="subject" value="$subject" size="30" /><br /><br />
<textarea name="comment" cols="80" rows="14" id="comment" $textareaclass>$comment</textarea>
ENDDISCUSS
    if ($env{'form.origpage'}) {
        $postingform .= '<input type="hidden" name="origpage" value="'.
                        $env{'form.origpage'}.'" />'."\n";
        foreach my $att (@{$currnewattach}) {
            $postingform .= '<input type="hidden" name="currnewattach" '.
                            'value="'.$att.'" />'."\n";
        }
    }
    if (exists($env{'form.ref'})) {
        $postingform .= '<input type="hidden" name="ref" value="'.
                        $env{'form.ref'}.'" />';
    }
    if ($group ne '') {
        $postingform .='<input type="hidden" name="group" value="'.$group.'" />';
    }
    my $blockblog = &Apache::loncommon::blocking_status('blogs');
    if (!$blockblog) {
        $postingform .= &add_blog_checkbox($crstype);
    }
    $postingform .= "</form>\n";
    $postingform .= &generate_attachments_button('',$attachnum,$ressymb,
                                                     $now,$currnewattach,
                                                     $currdelold,'',$mode,
                                                     $blockblog);
    if ((ref($currnewattach) eq 'ARRAY') && (@{$currnewattach} > 0)) {
        $newattachmsg = '<br /><b>'.$lt{'newa'}.'</b><br />';
        if (@{$currnewattach} > 1) {
             $newattachmsg .= '<ol>';
             foreach my $item (@{$currnewattach}) {
                $item =~ m#.*/([^/]+)$#;
                $newattachmsg .= '<li><a href="'.$item.'">'.$1.'</a></li>'."\n";
             }
             $newattachmsg .= '</ol>'."\n";
         } else {
             $$currnewattach[0] =~ m#.*/([^/]+)$#;
             $newattachmsg .= '<a href="'.$$currnewattach[0].'">'.$1.'</a><br />'."\n";
         }
    }
    $postingform .= $newattachmsg;
    $postingform .= &generate_preview_button();
    return $postingform;
}

sub build_posting_display {
    my ($usernamesort,$subjectsort,$namesort,$notshown,$newitem,$dischash,$shown,$alldiscussion,$imsitems,$imsfiles,$roleinfo,$discussionitems,$replies,$depth,$posters,$maxdepth,$visible,$newpostsflag,$current,$status,$viewgrades,$seeid,$prevread,$sortposts,$ressymb,$target,$readkey,$showunmark,$showonlyunread,$totposters,$rolefilter,$sectionpick,$grouppick,$classgroups,$statusfilter,$toggkey,$outputtarget,$anonhash,$anoncnt,$group) = @_;
    my @original=();
    my @index=();
    my $skip_group_check = 0;
    my $symb=&Apache::lonenc::check_decrypt($ressymb);
    my $escsymb=&escape($ressymb);
    my %contrib=&Apache::lonnet::restore($symb,$env{'request.course.id'},
			  $env{'course.'.$env{'request.course.id'}.'.domain'},
			  $env{'course.'.$env{'request.course.id'}.'.num'});

    my $see_anonymous = 
	&Apache::lonnet::allowed('rin',$env{'request.course.id'}.($env{'request.course.sec'}?'/'.$env{'request.course.sec'}:''));

    if ((@{$grouppick} == 0) || (grep(/^all$/,@{$grouppick}))) {
        $skip_group_check = 1;
    }
    my (%deletions,%hiddens);
    if ($contrib{'deleted'}) {
       my $deleted = $contrib{'deleted'};
       $deleted =~ s/^\.//;
       $deleted =~ s/\.$//;
       %deletions = map { $_ => 1 } (split(/\.\./,$deleted));
    }
    if ($contrib{'hidden'}) {
       my $hidden = $contrib{'hidden'};
       $hidden =~ s/^\.//;
       $hidden =~ s/\.$//;
       %hiddens = map { $_ => 1 } (split(/\.\./,$hidden));
    }
    if ($contrib{'version'}) {
        my $oldest = $contrib{'1:timestamp'};
        if ($prevread eq '0') {
            $prevread = $oldest-1;
        }
        my ($skiptest,$rolematch,$roleregexp,$secregexp,$statusregexp);
        if ($sortposts) {
            ($skiptest,$roleregexp,$secregexp,$statusregexp) = 
                     &filter_regexp($rolefilter,$sectionpick,$statusfilter);
            $rolematch = $roleregexp.':'.$secregexp.':'.$statusregexp;
        } 
	for (my $id=1;$id<=$contrib{'version'};$id++) {
	    my $idx=$id;
            next if ($contrib{$idx.':deleted'});
            next if ($contrib{$idx.':hidden'});
            my $posttime = $contrib{$idx.':timestamp'};
            if ($prevread <= $posttime) {
                $$newpostsflag = 1;
            }
            my $studenthidden=($contrib{'studenthidden'}=~/\.$idx\./);
	    my $origindex='0.';
            my $numoldver=0;
	    if ($contrib{$idx.':replyto'}) {
                if ( (($env{'environment.threadeddiscussion'}) && ($sortposts eq '')) || ($sortposts eq 'thread') || ($outputtarget eq 'export')) {
# this is a follow-up message
		    $original[$idx]=$original[$contrib{$idx.':replyto'}];
		    $$depth[$idx]=$$depth[$contrib{$idx.':replyto'}]+1;
		    $origindex=$index[$contrib{$idx.':replyto'}];
		    if ($$depth[$idx]>$$maxdepth) { $$maxdepth=$$depth[$idx]; }
                } else {
                    $original[$idx]=0;
                    $$depth[$idx]=0;
                }
	    } else {
# this is an original message
		$original[$idx]=0;
		$$depth[$idx]=0;
	    }
	    if ($$replies[$$depth[$idx]]) {
		$$replies[$$depth[$idx]]++;
	    } else {
		$$replies[$$depth[$idx]]=1;
	    }
            unless ((($hiddens{$idx}) && (!$seeid)) || ($deletions{$idx})) {
		$$visible++;
                if ($contrib{$idx.':history'}) {
                    if ($contrib{$idx.':history'} =~ /:/) {
                        my @oldversions = split(/:/,$contrib{$idx.':history'});
                        $numoldver = @oldversions;
                    } else {
                        $numoldver = 1;
                    } 
                }
                $$current = $numoldver;
		my %messages = ();
                my %subjects = ();
                my %attachtxt = ();
                my %allattachments = ();
                my ($screenname,$plainname);
                my $sender = &mt('Anonymous');
# Anonymous users getting number within a discussion
# Since idx is in static order, this should give the same sequence every time. 
		my $key=$contrib{$idx.':sendername'}.'@'.$contrib{$idx.':senderdomain'};
		unless ($$anonhash{$key}) {
                    $anoncnt++;
		    $$anonhash{$key}=&mt('Anonymous').' '.$anoncnt;
		}
                my ($message,$subject,$vgrlink,$ctlink);
                &get_post_contents(\%contrib,$idx,$seeid,$outputtarget,\%messages,\%subjects,\%allattachments,\%attachtxt,$imsfiles,\$screenname,\$plainname,$numoldver);


# Set up for sorting by subject
                unless ($outputtarget eq 'export') {
                    $message=$messages{$numoldver};
                    $message.=$attachtxt{$numoldver};
                    $subject=$subjects{$numoldver};
                    if ($message) {
	  	        if ($hiddens{$idx}) {
			    $message='<font color="#888888">'.$message.'</font>';
                            if ($studenthidden) {
                                $message .='<br /><br />Deleted by poster (student).';
                            }
		        }

                        if ($subject eq '') {
                           if (defined($$subjectsort{'__No subject'})) {
                               push(@{$$subjectsort{'__No subject'}}, $idx);
                           } else {
                               @{$$subjectsort{'__No subject'}} = ("$idx");
                           }
                        } else {
                            if (defined($$subjectsort{$subject})) {
                               push(@{$$subjectsort{$subject}}, $idx);
                            } else {
                               @{$$subjectsort{$subject}} = ("$idx");
                            }
                        }
		        if (!$contrib{$idx.':anonymous'} || $see_anonymous) {
			    $sender=&Apache::loncommon::aboutmewrapper(
					 $plainname,
					 $contrib{$idx.':sendername'},
					 $contrib{$idx.':senderdomain'}).' ('.
					 $contrib{$idx.':sendername'}.':'.
					 $contrib{$idx.':senderdomain'}.')';
                            $sender = '<b>'.$sender.'</b>';
			    if ($contrib{$idx.':anonymous'}) {
			        $sender.=' <font color="red"><b>['.$$anonhash{$key}.']</b></font> '.
				    $screenname;
			    }
			    if ($see_anonymous) {
				$sender.=&Apache::loncommon::student_image_tag($contrib{$idx.':senderdomain'},$contrib{$idx.':sendername'});
			    }
# Set up for sorting by domain, then username
                            unless (defined($$usernamesort{$contrib{$idx.':senderdomain'}})) {
                                %{$$usernamesort{$contrib{$idx.':senderdomain'}}} = ();
                            }
                            if (defined($$usernamesort{$contrib{$idx.':senderdomain'}}{$contrib{$idx.':sendername'}})) {
                                push(@{$$usernamesort{$contrib{$idx.':senderdomain'}}{$contrib{$idx.':sendername'}}}, $idx);
                            } else {
                                @{$$usernamesort{$contrib{$idx.':senderdomain'}}{$contrib{$idx.':sendername'}}} = ("$idx");
                            }
# Set up for sorting by last name, then first name
                            my %names = &Apache::lonnet::get('environment',
                                 ['firstname','lastname'],$contrib{$idx.':senderdomain'},
                                  ,$contrib{$idx.':sendername'});
                            my $lastname = $names{'lastname'};
                            my $firstname = $names{'firstname'};
                            if ($lastname eq '') {
                                $lastname = '_';
                            }
                            if ($firstname eq '') {
                                $firstname = '_';
                            }
                            unless (defined($$namesort{$lastname})) {
                                %{$$namesort{$lastname}} = ();
                            }
                            if (defined($$namesort{$lastname}{$firstname})) {
                                push(@{$$namesort{$lastname}{$firstname}}, $idx);
                            } else {
                                @{$$namesort{$lastname}{$firstname}} = ("$idx");
                            }
                            if ($outputtarget ne 'tex') {
                                if (&editing_allowed($escsymb.':::'.$idx,$group)) {
                                    if (($env{'user.domain'} eq $contrib{$idx.':senderdomain'}) && ($env{'user.name'} eq $contrib{$idx.':sendername'})) {
                                        $sender.=' <a href="/adm/feedback?editdisc='.
                                             $escsymb.':::'.$idx;
                                        if ($$newpostsflag) {
                                            $sender .= '&amp;previous='.$prevread;
                                        }
				        $sender .= &group_args($group);
                                        $sender .= '" '.$target.'>'.&mt('Edit').'</a>';
                                    
                                        unless ($seeid) {
                                            my $grpargs = &group_args($group);
                                            $sender.=" <a href=\"javascript:verifydelete('studentdelete','$escsymb','$idx','$$newpostsflag','$prevread','$grpargs')";
                                            $sender .= '">'.&mt('Delete').'</a>';
                                        }
                                    }
                                }
			        if ($seeid) {
			            if ($hiddens{$idx}) {
                                        unless ($studenthidden) {
			                    $sender.=' <a href="/adm/feedback?unhide='.
				                     $escsymb.':::'.$idx;
                                            if ($$newpostsflag) {
                                                $sender .= '&amp;previous='.$prevread;
                                            }
                                            $sender .= '">'.&mt('Make Visible').'</a>';
                                        }
			            } else {
				        $sender.=' <a href="/adm/feedback?hide='.
				                 $escsymb.':::'.$idx;
                                        if ($$newpostsflag) {
                                            $sender .= '&amp;previous='.$prevread;
                                        }
				        $sender .= &group_args($group);
                                        $sender .= '">'.&mt('Hide').'</a>';
			            }
                                    my $grpargs = &group_args($group);
			            $sender.= 
                                        " <a href=\"javascript:verifydelete('seeiddelete','$escsymb','$idx','$$newpostsflag','$prevread','$grpargs')\">";
                                    $sender .= &mt('Delete').'</a>';
                                }
                            }
                        } else {
			    if ($screenname) {
			        $sender='<i>'.$screenname.'</i>';
			    } else {
				$sender='<i>'.$$anonhash{$key}.'</i>';
			    }
                            $sender = '<b>'.$sender.'</b>';
# Set up for sorting by domain, then username for anonymous
                            unless (defined($$usernamesort{'__anon'})) {
                                %{$$usernamesort{'__anon'}} = ();
                            }
                            if (defined($$usernamesort{'__anon'}{'__anon'})) {
                                push(@{$$usernamesort{'__anon'}{'__anon'}}, $idx);
                            } else {
                                @{$$usernamesort{'__anon'}{'__anon'}} = ("$idx");
                            }
# Set up for sorting by last name, then first name for anonymous
                            unless (defined($$namesort{'__anon'})) {
                                %{$$namesort{'__anon'}} = ();
                            }
                            if (defined($$namesort{'__anon'}{'__anon'})) {
                                push(@{$$namesort{'__anon'}{'__anon'}}, $idx);
                            } else {
                                @{$$namesort{'__anon'}{'__anon'}} = ("$idx");
                            }
		        }
                        if ($outputtarget ne 'tex') {
		            if (&discussion_open($status)) {
                                if (($group ne '') && 
                                    (&check_group_priv($group,'pgd') eq 'ok')) {
                                     $sender.=' <a href="/adm/feedback?replydisc='.
                                              $escsymb.':::'.$idx;
                                    if ($$newpostsflag) {
                                        $sender .= '&amp;previous='.$prevread;
                                    }
                                    $sender .= &group_args($group);
                                    $sender .= '" '.$target.'>'.&mt('Reply').'</a>';
                                } elsif (&Apache::lonnet::allowed('pch', 
				     $env{'request.course.id'}.
				     ($env{'request.course.sec'}?'/'.
                                      $env{'request.course.sec'}:''))) {
			             $sender.=' <a href="/adm/feedback?replydisc='.
			                      $escsymb.':::'.$idx;
                                    if ($$newpostsflag) {
                                        $sender .= '&amp;previous='.$prevread;
                                    }
                                    $sender .= '" '.$target.'>'.&mt('Reply').'</a>';
                                }
                            }
		            if ($viewgrades) {
			        $vgrlink=&Apache::loncommon::submlink(&mt('Submissions'),
                                $contrib{$idx.':sendername'},$contrib{$idx.':senderdomain'},$ressymb);
		            }
                            if ($$dischash{$readkey}=~/\.$idx\./) { 
                                $ctlink = '<label><b>'.&mt('Mark unread').'?</b>&nbsp;<input type="checkbox" name="postunread_'.$idx.'" /></label>';
                            } else {
                                $ctlink = '<label><b>'.&mt('Mark read').'?</b>&nbsp;<input type="checkbox" name="postread_'.$idx.'" /></label>';
                            }
                        }
                    }
#figure out at what position this needs to print
                }
                if ($outputtarget eq 'export' || $message) {
		    my $thisindex=$idx;
		    if ( (($env{'environment.threadeddiscussion'}) && ($sortposts eq '')) || ($sortposts eq 'thread') || ($outputtarget eq 'export')) {
			$thisindex=$origindex.substr('00'.$$replies[$$depth[$idx]],-2,2);
		    }
		    $$alldiscussion{$thisindex}=$idx;
                    $$shown{$idx} = 0;
                    $index[$idx]=$thisindex;
                }
                if ($outputtarget eq 'export') {
                    %{$$imsitems{$idx}} = ();
                    $$imsitems{$idx}{'isvisible'}='true';
                    if ($hiddens{$idx}) {
                        $$imsitems{$idx}{'isvisible'}='false';
                    }
                    $$imsitems{$idx}{'title'}=$subjects{$numoldver};
                    $$imsitems{$idx}{'message'}=$messages{$numoldver};
                    $$imsitems{$idx}{'attach'}=$attachtxt{$numoldver};
                    $$imsitems{$idx}{'timestamp'}=$contrib{$idx.':timestamp'};
                    $$imsitems{$idx}{'sender'}=$plainname.' ('.
                                         $contrib{$idx.':sendername'}.':'.
                                         $contrib{$idx.':senderdomain'}.')';
                    $$imsitems{$idx}{'isanonymous'}='false';
                    if ($contrib{$idx.':anonymous'}) {
                        $$imsitems{$idx}{'isanonymous'}='true';
                    }
                    $$imsitems{$idx}{'currversion'}=$numoldver;
                    %{$$imsitems{$idx}{'allattachments'}}=%allattachments;
                    unless ($messages{$numoldver} eq '' && $attachtxt{$numoldver} eq '') {
                        $$shown{$idx} = 1;
                    }
                } else {
                    if ($message) {
                        my $spansize = 2;
                        if ($showonlyunread && $prevread > $posttime) {
                            $$notshown{$idx} = 1;
                        } elsif ($showunmark && $$dischash{$readkey}=~/\.$idx\./) {
                            $$notshown{$idx} = 1;
                        } else {
# apply filters
                            my $uname = $contrib{$idx.':sendername'};
                            my $udom = $contrib{$idx.':senderdomain'};
                            my $poster = $uname.':'.$udom;
                            if ($env{'form.totposters'} ne '') {
                                if ($totposters == 0) {
                                    $$shown{$idx} = 0;
                                } elsif ($totposters > 0) {
                                    if (grep/^$poster$/,@{$posters}) {
                                        $$shown{$idx} = 1;
                                    }
                                }
                            } elsif ($sortposts) {
                                if ($skiptest) {
                                    $$shown{$idx} = 1;
                                } else {
                                    foreach my $role (@{$$roleinfo{$poster}}) {
                                        if ($role =~ /^cc:/) {
                                            my $cc_regexp = $roleregexp.':[^:]*:'.$statusregexp;
                                            if ($role =~ /$cc_regexp/) {
                                                $$shown{$idx} = 1;
                                                last;
                                            }
                                        } elsif ($role =~ /^$rolematch$/) {
                                            $$shown{$idx} = 1;
                                            last;
                                        }
                                    }
                                }
                                if ($$shown{$idx} && !$skip_group_check) {
                                    my $showflag = 0;
                                    if (ref($$classgroups{$poster}{active}) eq 'HASH') {
                                        foreach my $grp (@{$grouppick}) {
                                            if (grep/^\Q$grp\E$/,
                                 keys(%{$$classgroups{$poster}{active}})) {
                                                $showflag = 1;
                                                last;
                                            }
                                        }
                                    }
                                    if ($showflag) {
                                        $$shown{$idx} = 1;
                                    } else {
                                        $$shown{$idx} = 0;
                                    }
                                }
                            } else {
                                $$shown{$idx} = 1;
                            }
                        }
                        unless ($$notshown{$idx} == 1) {
                            if ($prevread > 0 && $prevread <= $posttime) {
                                $$newitem{$idx} = 1;
                                $$discussionitems[$idx] .= '
                                  <table border="0" width="100%">
                                  <tr><td align="left"><font color="#FF0000"><b>'.&mt('NEW').'&nbsp;</b></font></td>';
                            } else {
                                $$newitem{$idx} = 0;
                                $$discussionitems[$idx] .= '
                                  <table border="0" width="100%">
                                  <tr><td align="left">&nbsp;</td>';
                            }
                            $$discussionitems[$idx] .= '<td align="left">&nbsp;&nbsp;'.
                                '<b>'.$subject.'</b>&nbsp;&nbsp;'.
                                $sender.' '.$vgrlink.' ('.
                                &Apache::lonlocal::locallocaltime($posttime).')</td>';
                            if ($$dischash{$toggkey}) {
                                $$discussionitems[$idx].='<td align="right">&nbsp;&nbsp;'.
                                  $ctlink.'</td>';
                            }
                            $$discussionitems[$idx].= '</tr></table><blockquote>'.
                                    $message.'</blockquote>';
                            if ($contrib{$idx.':history'}) {
                                my @postversions = ();
                                $$discussionitems[$idx] .= &mt('This post has been edited by the author.');
                                if ($seeid) {
                                    $$discussionitems[$idx] .= '&nbsp;&nbsp;<a href="/adm/feedback?allversions='.$escsymb.':::'.$idx;
				    $$discussionitems[$idx] .= &group_args($group);
                                    $$discussionitems[$idx] .= '">'.&mt('Display all versions').'</a>';
                                }
                                $$discussionitems[$idx].='<br/>'.&mt('Earlier version(s) were posted on: ');
                                if ($contrib{$idx.':history'} =~ m/:/) {
                                    @postversions = split(/:/,$contrib{$idx.':history'});
                                } else {
                                    @postversions = ("$contrib{$idx.':history'}");
                                }
                                for (my $i=0; $i<@postversions; $i++) {
                                    my $version = $i+1;
                                    $$discussionitems[$idx] .= '<b>'.$version.'.</b> - '.&Apache::lonlocal::locallocaltime($postversions[$i]).'  ';
                                }
                            }
                        }
                    }
                }
            }
	}
    }
}

sub filter_regexp {
    my ($rolefilter,$sectionpick,$statusfilter) = @_;
    my ($roleregexp,$secregexp,$statusregexp);
    my $skiptest = 1;
    if (@{$rolefilter} > 0) {
        my @okrolefilter = ();
        foreach my $role (@{$rolefilter}) {
            unless ($role eq '') {
                push(@okrolefilter, $role);
            }
        }
        if (@okrolefilter > 0) {
            if (grep/^all$/,@okrolefilter) {
                $roleregexp='[^:]+';
            } else {
                if (@okrolefilter == 1) {
                    $roleregexp=$okrolefilter[0];
                } else {
                    $roleregexp='('.join('|',@okrolefilter).')';
                }
                $skiptest = 0;
            }
        }
    }
    if (@{$sectionpick} > 0) {
        my @oksectionpick = ();
        foreach my $sec (@{$sectionpick}) {
            unless ($sec eq '') {
                 push(@oksectionpick, $sec);
            }
        }
        if ((@oksectionpick > 0) && (!grep/^all$/,@oksectionpick)) {
            if (@oksectionpick == 1) {
                $secregexp = $oksectionpick[0];
            } else {
                $secregexp .= '('.join('|',@oksectionpick).')';
            }
            $skiptest = 0;
        } else {
            $secregexp .= '[^:]*';
        }
    }

    if (defined($statusfilter) && $statusfilter ne '') {
        if ($statusfilter eq 'all') {
            $statusregexp = '[^:]+';
        } else {
            $statusregexp = $statusfilter;
            $skiptest = 0;
        }
    }
    return ($skiptest,$roleregexp,$secregexp,$statusregexp);
}


sub get_post_contents {
    my ($contrib,$idx,$seeid,$type,$messages,$subjects,$allattachments,$attachtxt,$imsfiles,$screenname,$plainname,$numver) = @_;
    my $discussion = '';
    my $start=$numver;
    my $end=$numver + 1;
    %{$$imsfiles{$idx}}=();
    if ($type eq 'allversions') {
       unless($seeid) {
           $discussion=&mt('You do not have privileges to view all versions of posts.').' '.&mt('Please select a different role.');
           return $discussion;
       } 
    }
#    $$screenname=&Apache::loncommon::screenname(
#                                        $$contrib{$idx.':sendername'},
#                                        $$contrib{$idx.':senderdomain'});
    $$plainname=&Apache::loncommon::nickname(
                                        $$contrib{$idx.':sendername'},
                                        $$contrib{$idx.':senderdomain'});
    $$screenname=$$contrib{$idx.':screenname'};

    my $sender=&Apache::loncommon::aboutmewrapper(
                                 $$plainname,
                                 $$contrib{$idx.':sendername'},
                                 $$contrib{$idx.':senderdomain'}).' ('.
                                 $$contrib{$idx.':sendername'}.':'.
                                 $$contrib{$idx.':senderdomain'}.')';
    my $attachmenturls = $$contrib{$idx.':attachmenturl'};
    my @postversions = ();
    if ($type eq 'allversions' || $type eq 'export') {
        $start = 0;
        if ($$contrib{$idx.':history'}) {
	    @postversions = split(/:/,$$contrib{$idx.':history'});
        }
        &get_post_versions($messages,$$contrib{$idx.':message'},1);
        &get_post_versions($subjects,$$contrib{$idx.':subject'},1);
        push(@postversions,$$contrib{$idx.':timestamp'});
        $end = @postversions;
    } else {
        &get_post_versions($messages,$$contrib{$idx.':message'},1,$numver);
        &get_post_versions($subjects,$$contrib{$idx.':subject'},1,$numver);
    }

    if ($$contrib{$idx.':anonymous'}) {
        $sender.=' ['.&mt('anonymous').'] '.$$screenname;
    }
    if ($type eq 'allversions') {
        $discussion=('<b>'.$sender.'</b><br /><ul>');
    }
    for (my $i=$start; $i<$end; $i++) {
        my ($timesent,$attachmsg);
        my %currattach = ();
        $timesent = &Apache::lonlocal::locallocaltime($postversions[$i]);
        unless (&contains_block_html($messages->{$i})) {
            &newline_to_br(\$messages->{$i});
        }
        $$messages{$i}=&Apache::lontexconvert::msgtexconverted($$messages{$i});
        $$subjects{$i}=~s/\n/\<br \/\>/g;
        $$subjects{$i}=&Apache::lontexconvert::msgtexconverted($$subjects{$i});
        if ($attachmenturls) {
            &extract_attachments($attachmenturls,$idx,$i,\$attachmsg,$allattachments,\%currattach);
        }
        if ($type eq 'export') {
            $$imsfiles{$idx}{$i} = '';
            if ($attachmsg) {
                $$attachtxt{$i} = '<br />'.&mt('Attachments').':<br />';
                foreach my $key (sort(keys(%currattach))) {
                    if ($$allattachments{$key}{'filename'} =~ m-^/uploaded/([^/]+/[^/]+)(/feedback)?(/?\d*)/([^/]+)$-) {
                        my $fname = $1.$3.'/'.$4;
                        $$imsfiles{$idx}{$i} .= '<file href="'.$fname.'" />'."\n";
                        $$attachtxt{$i}.= '<a href="'.$fname.'">'.$4.'</a><br />';
                    }
                }
            }
        } else {
            if ($attachmsg) {
                $$attachtxt{$i} = '<br />'.&mt('Attachments').':'.$attachmsg.'<br />';
            } else {
                $$attachtxt{$i} = '';
            }
        }
        if ($type eq 'allversions') {
            $discussion.= <<"END";
<li><b>$$subjects{$i}</b>, $timesent<br />
$$messages{$i}<br />
$$attachtxt{$i}</li>
END
        }
    }
    if ($type eq 'allversions') {
        $discussion.='</ul>';
        return $discussion;
    } else {
        return;
    }
}

sub replicate_attachments {
    my ($attachrefs,$tempexport) = @_;
    my $response;
    foreach my $id (keys(%{$attachrefs})) {
        if ($$attachrefs{$id}{'filename'} =~ m-^/uploaded/([^/]+)/([^/]+)(/feedback)?(/?\d*)/([^/]+)$-) {
            my $path = $tempexport;
            my $tail = $1.'/'.$2.$4;
            my @extras = split(/\//,$tail);
            my $destination = $tempexport.'/'.$1.'/'.$2.$4.'/'.$5;
            if (!-e $destination) {
                my $i= 0;
                while ($i<@extras) {
                    $path .= '/'.$extras[$i];
                    if (!-e $path) {
                        mkdir($path,0700);
                    }
                    $i ++;
                }
                my ($content,$rtncode);
                my $uploadreply = &Apache::lonnet::getuploaded('GET',$$attachrefs{$id}{'filename'},$1,$2,$content,$rtncode);
                if ($uploadreply eq 'ok') {
                    my $attachcopy;
                    if ($attachcopy = Apache::File->new('>'.$destination)) {
                        print $attachcopy $content;
                        close($attachcopy);
                    } else {
                        $response .= &mt('Error copying file attachment - [_1] to IMS package',$5).': '.$!.'<br />'."\n";
                    }
                } else {
                    &Apache::lonnet::logthis("Replication of attachment failed when building IMS export of discussion posts - domain: $1, course: $2, file: $$attachrefs{$id}{'filename'} -error: $rtncode");
                    $response .= &mt('Error copying file attachment - [_1] to IMS package: ',$5).$rtncode.'<br />'."\n";
                }
            }
        }
    }
    return $response;
}

sub mail_screen {
  my ($r,$feedurl,$options,$caller_symb,$attachmaxtext) = @_;
  if (exists($env{'form.origpage'})) {
      &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},['subject','comment','currnewattach','addnewattach','deloldattach','delnewattach','timestamp','idx','anondiscuss','discuss','blog','group','ref']);
  }

  my %lt = &Apache::lonlocal::texthash(
            'myqu' => 'My question/comment/feedback:',
            'title' => 'Title',
            'reta' => 'Retained attachments',
            'atta' => 'Attachment',
           );
  my $restitle = &get_resource_title($caller_symb,$feedurl);
  my $quote='';
  my $subject = '';
  my $comment = '';
  my $prevtag = '';
  my $parentmsg = '';
  my ($symb,$idx,$attachmenturls);
  my $numoldver = 0;
  my $attachmsg = '';
  my $newattachmsg = '';
  my @currnewattach = ();
  my @currdelold = ();
  my @keepold = ();
  my %attachments = ();
  my %currattach = ();
  my $attachnum = 0;
  my $anonchk = (<<END);
  function anonchk() {
      for (var i=0; i < document.mailform.discuss.length; i++) {
	  if (document.mailform.discuss[i].checked) {
	      document.attachment.discuss.value = 
		  document.mailform.discuss[i].value;
	  }
      }
      if (document.mailform.blog.checked) {
	  document.attachment.blog.value = 1;
      }
     return
   }
END
  my $anonscript;
  if (exists($env{'form.origpage'})) {
      $anonscript = (<<END);
  function setposttype() {
      var disc = "$env{'form.discuss'}";
      for (var i=0; i < document.mailform.discuss.length; i++) {
	  if (disc == document.mailform.discuss[i].value) {
	      document.mailform.discuss[i].checked = 1;
	  }
      }
      var blog = "$env{'form.blog'}";
      if (blog == 1) {
          document.mailform.blog.checked=1;
      }
      return
  }
END
  } else {
      $anonscript = (<<END);
  function setposttype() {
      return
  }
END
  }
  if (($env{'form.replydisc'}) || ($env{'form.editdisc'})) {
      if ($env{'form.replydisc'}) {
          ($symb,$idx)=split(/\:\:\:/,$env{'form.replydisc'});
      } else {
          ($symb,$idx)=split(/\:\:\:/,$env{'form.editdisc'});
      }
      my %contrib=&Apache::lonnet::restore($symb,$env{'request.course.id'},
					   $env{'course.'.$env{'request.course.id'}.'.domain'},
					   $env{'course.'.$env{'request.course.id'}.'.num'});
      unless (($contrib{'hidden'}=~/\.$idx\./) || ($contrib{'deleted'}=~/\.$idx\./)) {
          if ($contrib{$idx.':history'}) {
              if ($contrib{$idx.':history'} =~ /:/) {
                  my @oldversions = split(/:/,$contrib{$idx.':history'});
                  $numoldver = @oldversions;
              } else {
                  $numoldver = 1;
              }
          }
          if ($env{'form.replydisc'}) {
              if ($contrib{$idx.':history'}) {
                  if ($contrib{$idx.':history'} =~ /:/) {
                      my @oldversions = split(/:/,$contrib{$idx.':history'});
                      $numoldver = @oldversions;
                  } else {
                      $numoldver = 1;
                  }
              }
              if ($idx > 0) {
                  my %msgversions = ();
                  &get_post_versions(\%msgversions,$contrib{$idx.':message'},0,$numoldver);
                  $quote = $msgversions{$numoldver};
              }
              if ($idx > 0) {
                  my %subversions = ();
                  &get_post_versions(\%subversions,$contrib{$idx.':subject'},1,$numoldver);
                  $subject = &mt('Re: ').$subversions{$numoldver};
              }
              $subject = &HTML::Entities::encode($subject,'<>&"');
          } else {
              $attachmenturls = $contrib{$idx.':attachmenturl'};
              if ($idx > 0) {
                  my %msgversions = ();
                  &get_post_versions(\%msgversions,$contrib{$idx.':message'},0,$numoldver);
                  $comment = $msgversions{$numoldver};
                  my %subversions = ();
                  &get_post_versions(\%subversions,$contrib{$idx.':subject'},0,$numoldver);
                  $subject = $subversions{$numoldver}; 
              }
              if (defined($contrib{$idx.':replyto'})) {
                  $parentmsg = $contrib{$idx.':replyto'};
              }
              unless (exists($env{'form.origpage'})) {
                  my $anonflag = 'nonanon';
                  if ($contrib{$idx.':anonymous'}) {
                      $anonflag = 'anon';
                  }
                  $anonscript = (<<END);
  function setposttype () {
      var currtype = "$anonflag";
      for (var i=0; i<document.mailform.discuss.length; i++) {
	  if (document.mailform.elements.discuss[i].value == currtype ) {
	      document.mailform.elements.discuss[i].checked=1;
	  } 
      }
      return
  }
END
              }
          }
      }
      if ($env{'form.previous'}) {
          $prevtag = '<input type="hidden" name="previous" value="'.$env{'form.previous'}.'" />';
      }
  }

  if ($env{'form.origpage'}) {
      $subject = &unescape($env{'form.subject'});
      $comment = &unescape($env{'form.comment'});
      &process_attachments(\@currnewattach,\@currdelold,\@keepold);
  }
  my $latexHelp=&Apache::loncommon::helpLatexCheatsheet(undef,undef,1);
  my $send=&mt('Send');
  my $alert = &mt('Please select a feedback type.');
  my $js= <<END;
<script type="text/javascript">
//<!--
    function gosubmit() {
        var rec=0;
        if (typeof(document.mailform.elements.discuss)!="undefined") {
	    if (typeof(document.mailform.elements.discuss.length) == "undefined") {
		if (document.mailform.elements.discuss.checked ) {
		    rec=1;
		}
	    } else {
		for (var i=0; i<document.mailform.elements.discuss.length; i++) {
		    if (document.mailform.elements.discuss[i].checked ) {
			rec=1;
		    } 
		}
	    }
	}
        if (typeof(document.mailform.elements.blog)!="undefined") {
          if (document.mailform.elements.blog.checked) {
             rec=1;
          } 
        }

        if (rec) {
            if (typeof(document.mailform.onsubmit)=='function') {
		document.mailform.onsubmit();
	    }
	    document.mailform.submit();
        } else {
            alert('$alert');
	}
    }
    $anonchk
    $anonscript
//-->
</script>
END

  my ($textareaheader,$textareaclass);
  if (&Apache::lonhtmlcommon::htmlareabrowser()) {
      $textareaheader = &Apache::lonhtmlcommon::htmlareaselectactive();
      $textareaclass = 'class="LC_richDefaultOff"';
      if ($env{'request.course.id'}) {
          unless (($env{'course.'.$env{'request.course.id'}.'.allow_limited_html_in_feedback'} =~ /^\s*yes\s*$/i) || ($env{'form.sendmessageonly'})) {
              undef($textareaclass);
          }
      }
  }

  # Breadcrumbs
  my $brcrum = [{'href' => '',
                 'text' => 'Resource Feedback and Discussion'}];

  my %onload = ('onload' => 'window.focus();setposttype();');
  my $start_page=
      &Apache::loncommon::start_page('Resource Feedback and Discussion',$js,
                                     {'add_entries' => \%onload,
                                      'bread_crumbs' => $brcrum,});

  if ($quote ne '') {
      $quote = &HTML::Entities::decode($quote);
      unless (&contains_block_html($quote)) {
          &newline_to_br(\$quote);
      }
      $quote='<blockquote>'.&Apache::lontexconvert::msgtexconverted($quote).'</blockquote>';
  }

  $r->print(<<END);
$start_page
<h2><tt>$restitle</tt></h2>
<form action="/adm/feedback" method="post" name="mailform"
enctype="multipart/form-data">
$prevtag
<input type="hidden" name="postdata" value="$feedurl" />
END
  if ($env{'form.replydisc'}) {
      $r->print(<<END);
<input type="hidden" name="replydisc" value="$env{'form.replydisc'}" />
END
  } elsif ($env{'form.editdisc'}) {
     $r->print(<<END);
<input type="hidden" name="editdisc" value="$env{'form.editdisc'}" />
<input type="hidden" name="parentmsg" value="$parentmsg" />
END
  }
  $r->print(<<END);
$options<hr />
$quote
<p>$lt{'myqu'}
$textareaheader
</p>
<p>
$latexHelp
</p>
<p>
$lt{'title'}: <input type="text" name="subject" size="30" value="$subject" /></p>
<p>
<textarea name="comment" id="comment" cols="60" rows="10" $textareaclass>$comment
</textarea></p>
END
    if ( ($env{'form.editdisc'}) || ($env{'form.replydisc'}) ) {
        if ($env{'form.origpage'}) {
            foreach my $attach (@currnewattach) {
                $r->print('<input type="hidden" name="currnewattach" value="'.$attach.'" />'."\n");
            }
            foreach my $oldatt (@currdelold) {
                $r->print('<input type="hidden" name="deloldattach" value="'.$oldatt.'" />'."\n");
            }
        }
        if ($env{'form.editdisc'}) {
            if ($attachmenturls) {
                &extract_attachments($attachmenturls,$idx,$numoldver,\$attachmsg,\%attachments,\%currattach,\@currdelold);
                $attachnum = scalar(keys(%currattach));
                foreach my $key (keys(%currattach)) {
                    $r->print('<input type="hidden" name="keepold" value="'.$key.'" />'."\n");
                }
            }
        }
    } else {
        $r->print(<<END);
<p>
$lt{'atta'} $attachmaxtext: <input type="file" name="attachment" />
</p>
END
    }
    if (exists($env{'form.group'})) {
        $r->print('<input type="hidden" name="group" value="'.$env{'form.group'}.'" />');
    }
    if (exists($env{'form.ref'})) {
        $r->print('<input type="hidden" name="ref" value="'.$env{'form.ref'}.'" />');
    }
    $r->print(<<END);
<p>
<input type="hidden" name="sendit" value="1" />
<input type="button" value="$send" onclick='gosubmit();' />
</p>
</form>
END
    if ($env{'form.editdisc'} || $env{'form.replydisc'}) {
        my $now = time;
        my $ressymb = $symb;
        &Apache::lonenc::check_encrypt(\$ressymb);
        my $postidx = '';
        if ($env{'form.editdisc'}) {
            $postidx = $idx;
        }
        if (@currnewattach > 0) {
            $attachnum += @currnewattach;
        }
        my $blockblog = &Apache::loncommon::blocking_status('blogs');
        $r->print(&generate_attachments_button($postidx,$attachnum,$ressymb,$now,\@currnewattach,\@currdelold,$numoldver,'',$blockblog));
        if ($attachnum > 0) {
            if (@currnewattach > 0) {
                $newattachmsg .= '<br /><b>'.&mt('New attachments').'</b><br />';
                if (@currnewattach > 1) {
                    $newattachmsg .= '<ol>';
                    foreach my $item (@currnewattach) {
                        $item =~ m#.*/([^/]+)$#;
                        $newattachmsg .= '<li><a href="'.$item.'">'.$1.'</a></li>'."\n";
                    }
                    $newattachmsg .= '</ol>'."\n";
                } else {
                    $currnewattach[0] =~ m#.*/([^/]+)$#;
                    $newattachmsg .= '<a href="'.$currnewattach[0].'">'.$1.'</a><br />'."\n";
                }
            }
            if ($attachmsg) {
                $r->print("<br /><b>$lt{'reta'}</b>:$attachmsg<br />\n");
            }
            if ($newattachmsg) {
                $r->print("$newattachmsg<br />");
            }
        }
    }
    $r->print(&generate_preview_button().
	      &Apache::loncommon::end_page());

}

sub print_display_options {
    my ($r,$symb,$previous,$dispchgA,$dispchgB,$markchg,$toggchg,$feedurl) = @_;
    &Apache::loncommon::content_type($r,'text/html');
    $r->send_http_header;

    my $function = &Apache::loncommon::get_users_function();
    my $tabcolor = &Apache::loncommon::designparm($function.'.tabbg',
                                                    $env{'user.domain'});

    my %lt = &Apache::lonlocal::texthash(
        'pref' => 'Display Preference',
        'curr' => 'Current setting ',
        'actn' => 'Action',
        'deff' => 'Default for all discussions',
        'prca' => 'Preferences can be set for this discussion that determine ....',
        'whpo' => 'Which posts are displayed when you display this discussion board or resource, and',
        'unwh' => 'Under what circumstances posts are identified as "NEW", and',
        'wipa' => 'Whether individual posts can be marked as read/unread',
        'allposts' => 'All posts',
        'unread' => 'New posts only',
        'unmark' => 'Posts not marked read',
        'ondisp' => 'Once displayed',
        'onmark' => 'Once marked not NEW',
        'toggon' => 'Shown',
        'toggoff' => 'Not shown',
        'disa' => 'Posts displayed?',
        'npmr' => 'New posts cease to be identified as "NEW"?',
        'dotm' => 'Option to mark each post as read/unread?',  
        'chgt' => 'Change to ',
        'mkdf' => 'Set to ',
        'yhni' => 'You have not indicated that you wish to change any of the discussion settings',
        'ywbr' => 'You will be returned to the previous page if you click OK.'
    );

    my $dispchangeA = $lt{'unread'};
    my $dispchangeB = $lt{'unmark'};
    my $markchange = $lt{'ondisp'};
    my $toggchange = $lt{'toggon'};
    my $currdisp = $lt{'allposts'};
    my $currmark = $lt{'onmark'};
    my $discdisp = 'allposts';
    my $discmark = 'onmark';
    my $currtogg = $lt{'toggoff'};
    my $disctogg = 'toggoff';
                                                                                      
    if ($dispchgA eq 'allposts') {
        $dispchangeA = $lt{'allposts'};
        $currdisp = $lt{'unread'};
        $discdisp = 'unread';
    }

    if ($markchg eq 'markonread') {
        $markchange = $lt{'onmark'};
        $currmark = $lt{'ondisp'};
        $discmark = 'ondisp';
    }

    if ($dispchgB eq 'onlyunread') {
        $dispchangeB = $lt{'unread'};
        $currdisp = $lt{'unmark'};
        $discdisp = 'unmark';
    }
    if ($toggchg eq 'toggoff') {
        $toggchange = $lt{'toggoff'};
        $currtogg = $lt{'toggon'};
        $disctogg = 'toggon';
    }

    my $js = <<END;
<script type="text/javascript">
function discdispChk(caller) {
    var disctogg = '$toggchg'
    if (caller == 0) {
        if (document.modifydisp.discdisp[0].checked == true) {
            if (document.modifydisp.discdisp[1].checked == true) {
                document.modifydisp.discdisp[1].checked = false
            }
        }
    }
    if (caller == 1) {
        if (document.modifydisp.discdisp[1].checked == true) {
            if (document.modifydisp.discdisp[0].checked == true) {
                document.modifydisp.discdisp[0].checked = false
            }
            if (disctogg == 'toggon') {
                document.modifydisp.disctogg.checked = true
            }
            if (disctogg == 'toggoff') {
                document.modifydisp.disctogg.checked = false
            }
        }
    }
    if (caller == 2) {
        var dispchgB = '$dispchgB'
        if (disctogg == 'toggoff') {
            if (document.modifydisp.disctogg.checked == true) {
                if (dispchgB == 'onlyunmark') {
                    document.modifydisp.discdisp[1].checked = false
                }
            }
        }
    }  
}

function setDisp() {
    var prev = "$previous"
    var chktotal = 0
    if (document.modifydisp.discdisp[0].checked == true) {
        document.modifydisp.$dispchgA.value = "$symb"
        chktotal ++
    }
    if (document.modifydisp.discdisp[1].checked == true) {
        document.modifydisp.$dispchgB.value = "$symb"
        chktotal ++
    }
    if (document.modifydisp.discmark.checked == true) {
        document.modifydisp.$markchg.value = "$symb"
        chktotal ++
    }
    if (document.modifydisp.disctogg.checked == true) {
        document.modifydisp.$toggchg.value = "$symb"
        chktotal ++
    }
    if (chktotal > 0) { 
        document.modifydisp.submit()
    } else {
        if(confirm("$lt{'yhni'}. \\n$lt{'ywbr'}"))      {
            if (prev > 0) {
                location.href = "$feedurl?previous=$previous"
            } else {
                location.href = "$feedurl"
            }
        }
    }
}
</script>
END


    my $start_page =
	&Apache::loncommon::start_page('Discussion display options',$js);
    my $end_page =
	&Apache::loncommon::end_page();
    $r->print(<<END);
$start_page
<form name="modifydisp" method="post" action="/adm/feedback">
$lt{'sdpf'}<br/> $lt{'prca'}  <ol><li>$lt{'whpo'}</li><li>$lt{'unwh'}</li><li>$lt{'wipa'}</li></ol>
<br />
END
    $r->print(&Apache::loncommon::start_data_table());
    $r->print(<<END);
       <tr>
        <th>$lt{'pref'}</td>
        <th>$lt{'curr'}</td>
        <th>$lt{'actn'}?</td>
       </tr>
END
    $r->print(&Apache::loncommon::start_data_table_row());
    $r->print(<<END);
       <td>$lt{'disa'}</td>
       <td>$lt{$discdisp}</td>
       <td><label><input type="checkbox" name="discdisp" onclick="discdispChk('0')" />&nbsp;$lt{'chgt'} "$dispchangeA"</label>
           <br />
           <label><input type="checkbox" name="discdisp" onclick="discdispChk('1')" />&nbsp;$lt{'chgt'} "$dispchangeB"</label>
       </td>
END
    $r->print(&Apache::loncommon::end_data_table_row());
    $r->print(&Apache::loncommon::start_data_table_row());
    $r->print(<<END);
       <td>$lt{'npmr'}</td>
       <td>$lt{$discmark}</td>
       <td><label><input type="checkbox" name="discmark" />$lt{'chgt'} "$markchange"</label></td>
END
    $r->print(&Apache::loncommon::end_data_table_row());
    $r->print(&Apache::loncommon::start_data_table_row());
    $r->print(<<END);
       <td>$lt{'dotm'}</td>
       <td>$lt{$disctogg}</td>
       <td><label><input type="checkbox" name="disctogg" onclick="discdispChk('2')" />$lt{'chgt'} "$toggchange"</label></td>
END
    my $save = &mt('Save');
    $r->print(&Apache::loncommon::end_data_table_row());
    $r->print(&Apache::loncommon::end_data_table());
    $r->print(<<END);
<br />
<br />
<input type="hidden" name="symb" value="$symb" />
<input type="hidden" name="previous" value="$previous" />
<input type="hidden" name="$dispchgA" value="" />
<input type="hidden" name="$dispchgB" value="" />
<input type="hidden" name="$markchg" value="" />
<input type="hidden" name="$toggchg" value="" />
<input type="button" name="sub" value="$save" onclick="javascript:setDisp()" />
END
    if (exists($env{'form.group'})) {
        $r->print('<input type="hidden" name="group" value="'.$env{'form.group'}.'" />');
    }
    if (exists($env{'form.ref'})) {
        $r->print('<input type="hidden" name="ref" value="'.$env{'form.ref'}.'" />');
    }
    $r->print("
<br />
<br />
</form>
$end_page
    ");
    return;
}

sub print_sortfilter_options {
    my ($r,$symb,$previous,$feedurl) = @_;

    &Apache::loncommon::content_type($r,'text/html');
    $r->send_http_header;

    &Apache::lonenc::check_encrypt(\$symb);
    my @sections;
    my $section_sel = '';
    my $numvisible = 5;
    my @groups;
    my $group_sel = '';
    my $numgroupvis = 5;
    my %sectioncount = &Apache::loncommon::get_sections();
    my @courseroles = qw(st ad ep ta in);
    my $crstype = &Apache::loncommon::course_type();
    my $ccrole = 'cc';
    if ($crstype eq 'Community') {
        $ccrole = 'co';
    }
    push(@courseroles,$ccrole);
    
    if ($env{'request.course.sec'} !~ /^\s*$/) {  #Restrict section choice to current section 
        @sections = ('all',$env{'request.course.sec'});
        $numvisible = 2;
    } else {
        @sections = sort {$a cmp $b} keys(%sectioncount);
        if (scalar(@sections) < 4) {
            $numvisible = scalar(@sections) + 1;
        }
        unshift(@sections,'all'); # Put 'all' at the front of the list

    }
    foreach my $sec (@sections) {
        $section_sel .= "  <option value=\"$sec\">$sec</option>\n";
    }

    if (&check_group_priv() eq 'ok') {
        my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
        my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'}; 
        my %curr_groups = &Apache::longroup::coursegroups($cdom,$cnum);
        @groups = sort {$a cmp $b} keys(%curr_groups);
        if (scalar(@groups) < 4) {
            $numgroupvis = scalar(@groups) + 1;
        }
        unshift(@groups,'all'); # Put 'all' at the front of the list
    } else { 
        my @coursegroups = split(/:/,$env{'request.course.groups'});
        if (@coursegroups > 0) {
            @coursegroups = sort {$a cmp $b} @coursegroups;
            @groups = ('all',@coursegroups);
            if (scalar(@groups) < 4) {
                $numgroupvis = scalar(@groups) + 1;
            }
        } else {
            @groups = ('all');
            $numgroupvis = 1;
        }
    }
    foreach my $group (@groups) {
        $group_sel .= "  <option value=\"$group\">$group</option>\n";
    }

    my $function = &Apache::loncommon::get_users_function();
    my $tabcolor = &Apache::loncommon::designparm($function.'.tabbg',
                                                    $env{'user.domain'});
    my %lt = &Apache::lonlocal::texthash(
        'diop' => 'Display Options',
        'curr' => 'Current setting ',
        'actn' => 'Action',
        'prca' => 'Set options that control the sort order of posts, and/or which posts are displayed.',
        'soor' => 'Sort order',
        'spur' => 'Specific user roles',
        'sprs' => 'Specific role status',
        'spse' => 'Specific sections',
        'spgr' => 'Specific groups',
        'psub' => 'Pick specific users (by name)',
        'shal' => 'Show a list of current posters',
        'stor' => 'Save changes',
    );

    my %sort_types = ();
    my %role_types = ();
    my %status_types = ();
    &sort_filter_names(\%sort_types,\%role_types,\%status_types,$crstype);

    my $js = <<END;
<script type="text/javascript">
function verifyFilter() {
    var rolenum = 0
    for (var i=0; i<document.modifyshown.rolefilter.length; i++) {
        if (document.modifyshown.rolefilter.options[i].selected == true) {
            rolenum ++
        }
    }
    if (rolenum == 0) {
        document.modifyshown.rolefilter.options[0].selected = true
    }

    var secnum = 0
    for (var i=0; i<document.modifyshown.sectionpick.length; i++) {
        if (document.modifyshown.sectionpick.options[i].selected == true) {
            secnum ++
        }
    }
    if (secnum == 0) {
        document.modifyshown.sectionpick.options[0].selected = true
    }

    var grpnum = 0
    for (var i=0; i<document.modifyshown.grouppick.length; i++) {
        if (document.modifyshown.grouppick.options[i].selected == true) {
            grpnum ++
        }
    }
    if (grpnum == 0) {
        document.modifyshown.grouppick.options[0].selected = true
    }

    document.modifyshown.submit();
}
</script>
END

    my $start_page=
	&Apache::loncommon::start_page('Discussion options',$js);
    my $end_page=
	&Apache::loncommon::end_page();

    $r->print(<<END);
$start_page
<form name="modifyshown" method="post" action="/adm/feedback">
<b>$lt{'diso'}</b><br/> $lt{'prca'}
<br /><br />
<table border="0">
 <tr>
  <th>$lt{'soor'}</th>
  <th>&nbsp;</th>
  <th>$lt{'sprs'}</th>
  <th>&nbsp;</th>
  <th>$lt{'spur'}</th>
  <th>&nbsp;</th>
  <th>$lt{'spse'}</th>
  <th>&nbsp;</th>
  <th>$lt{'spgr'}</th>
  <th>&nbsp;</th>
  <th>$lt{'psub'}</th>
 </tr>
 <tr>
  <td align="center" valign="top">
   <select name="sortposts">
    <option value="ascdate" selected="selected">$sort_types{'ascdate'}</option>
    <option value="descdate">$sort_types{'descdate'}</option>
    <option value="thread">$sort_types{'thread'}</option>
    <option value="subject">$sort_types{'subject'}</option>
    <option value="username">$sort_types{'username'}</option>
    <option value="lastfirst">$sort_types{'lastfirst'}</option>
   </select>
  </td>
  <td>&nbsp;</td>
  <td align="center" valign="top">
   <select name="statusfilter">
    <option value="all" selected="selected">$status_types{'all'}</option>
    <option value="Active">$status_types{'Active'}</option>
    <option value="Expired">$status_types{'Expired'}</option>
    <option value="Future">$status_types{'Future'}</option>
   </select>
  </td>
  <td>&nbsp;</td>
  <td align="center" valign="top">
   <select name="rolefilter" multiple="multiple" size="5">
    <option value="all">$role_types{'all'}</option>
    <option value="st">$role_types{'st'}</option>
    <option value="$ccrole">$role_types{$ccrole}</option>
    <option value="in">$role_types{'in'}</option>
    <option value="ta">$role_types{'ta'}</option>
    <option value="ep">$role_types{'ep'}</option>
    <option value="ad">$role_types{'ad'}</option>
    <option value="cr">$role_types{'cr'}</option>
   </select>
  </td>
  <td>&nbsp;</td>
  <td align="center" valign="top">
   <select name="sectionpick" multiple="multiple" size="$numvisible">
    $section_sel
   </select>
  </td>
  <td>&nbsp;</td>
  <td align="center" valign="top">
   <select name="grouppick" multiple="multiple" size="$numvisible">
    $group_sel
   </select>
  </td>
  <td>&nbsp;</td>
  <td valign="top"><label><input type="checkbox" name="posterlist" value="$symb" />$lt{'shal'}</label></td>
 </tr>
</table>
<br />
<br />
<input type="hidden" name="previous" value="$previous" />
<input type="hidden" name="applysort" value="$symb" />
<input type="button" name="sub" value="$lt{'stor'}" onclick="verifyFilter()" />
END
    if (exists($env{'form.group'})) {
        $r->print('<input type="hidden" name="group" value="'.$env{'form.group'}.'" />');
    }
    if (exists($env{'form.ref'})) {
        $r->print('<input type="hidden" name="ref" value="'.$env{'form.ref'}.'" />');
    }
    $r->print("
<br />
<br />
</form>
$end_page
");
}

sub print_showposters {
    my ($r,$symb,$previous,$feedurl,$sortposts) = @_;

    &Apache::loncommon::content_type($r,'text/html');
    $r->send_http_header;

    &Apache::lonenc::check_encrypt(\$symb);
    my $crs='/'.$env{'request.course.id'};
    if ($env{'request.course.sec'}) {
        $crs.='_'.$env{'request.course.sec'};
    }
    $crs=~s/\_/\//g;
    my $seeid;
    my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
    my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
    my $group = $env{'form.group'};
    my $ressymb = &wrap_symb($symb);
    if (($group ne '') &&
        ($ressymb =~ m|^bulletin___\d+___adm/wrapper/adm/\Q$cdom\E/\Q$cnum\E/\d+/bulletinboard$|)) {
        if (&check_group_priv($group,'dgp') eq 'ok') {
            $seeid = 1;
        }
    } else {
        $seeid=&Apache::lonnet::allowed('rin',$crs);
    }
    my %contrib=&Apache::lonnet::restore($symb,$env{'request.course.id'},
                                         $cdom,$cnum);
    my %namesort = ();
    my %postcounts = ();

    my %lt = &Apache::lonlocal::texthash(
                                          sele => 'Select',
                                          full => 'Fullname',
                                          usdo => 'Username:domain',
                                          post => 'Posts',
                                        );
    if ($contrib{'version'}) {
        for (my $idx=1;$idx<=$contrib{'version'};$idx++) {
            my $hidden=($contrib{'hidden'}=~/\.$idx\./);
            my $deleted=($contrib{'deleted'}=~/\.$idx\./);
            unless ((($hidden) && (!$seeid)) || ($deleted)) {
                if ((!$contrib{$idx.':anonymous'}) || (&Apache::lonnet::allowed('rin',$env{'request.course.id'}.($env{'request.course.sec'}?'/'.$env{'request.course.sec'}:'')))) {
                    my %names = &Apache::lonnet::get('environment',['firstname','lastname'],$contrib{$idx.':senderdomain'},$contrib{$idx.':sendername'});
                    my $lastname = $names{'lastname'};
                    my $firstname = $names{'firstname'};
                    if ($lastname eq '') {
                        $lastname = '_';
                    }
                    if ($firstname eq '') {
                        $firstname = '_';
                    }
                    unless (defined($namesort{$lastname})) {
                        %{$namesort{$lastname}} = ();
                    }
                    my $poster =  $contrib{$idx.':sendername'}.':'.$contrib{$idx.':senderdomain'};
                    $postcounts{$poster} ++;
                    if (defined($namesort{$lastname}{$firstname})) {
                        if (!grep/^$poster$/,@{$namesort{$lastname}{$firstname}}) {
                            push(@{$namesort{$lastname}{$firstname}}, $poster);
                        }
                    } else {
                        @{$namesort{$lastname}{$firstname}} = ("$poster");
                    }
                }
            }
        }
    }

    my $start_page = &Apache::loncommon::start_page('Discussion options');
    my $table_start =&Apache::loncommon::start_data_table();
    $r->print(<<END);
$start_page
 <form name="pickpostersform" method="post">
 <br />
    $table_start
      <tr>
       <th>#</th>
       <th>$lt{'sele'}</th>
       <th>$lt{'full'} <font color="#999999">($lt{'usdo'})</font></th>
       <th>$lt{'post'}</th>
      </tr>
END
    my $count = 0;
    foreach my $last (sort(keys(%namesort))) {
        foreach my $first (sort(keys(%{$namesort{$last}}))) {
            foreach my $user (sort(@{$namesort{$last}{$first}})) {
                my ($uname,$udom) = split(/:/,$user);
                if (!$uname || !$udom) { 
                    next;
                } else {
                    $count ++;
                    $r->print(&Apache::loncommon::start_data_table_row().
			      '<td align="right">'.$count.'</td>
                               <td align="center"><label><input name="stuinfo" type="checkbox" value="'.$user.'" /></td>
                               <td>'.$last.', '.$first.' ('.$uname.':'.$udom.')</label></td>
                               <td>'.$postcounts{$user}.'</td>'.
			      &Apache::loncommon::end_data_table_row());
                }
            }
        }
    }
    $r->print(&Apache::loncommon::end_data_table());
    my $end_page   = &Apache::loncommon::end_page();
    $r->print(<<END);
<br />
<input type="hidden" name="sortposts" value="$sortposts" />
<input type="hidden" name="userpick" value="$symb" />
<input type="button" name="store" value="Display posts" onclick="javascript:document.pickpostersform.submit()" />
</form>
$end_page
END
}

sub get_post_versions {
    my ($versions,$incoming,$htmldecode,$numver) = @_;
    if ($incoming =~ /^<version num="0">/) {
        my $p = HTML::LCParser->new(\$incoming);
        my $done = 0; 

        while ( (my $token = $p->get_tag("version")) && (!$done)) {
            my $num = $token->[1]{num};
            my $text = $p->get_text("/version");
            if (defined($numver)) {
                if ($num == $numver) {
                    if ($htmldecode) {
                        $text = &HTML::Entities::decode($text);
                    }
                    $$versions{$numver}=$text;
                    $done = 1;
                }
            } else {
                if ($htmldecode) {
                    $text = &HTML::Entities::decode($text);
                }
                $$versions{$num}=$text;
            }
        }
    } else {
        if (!defined($numver)) {
            $numver = 0;
        }
        if ($htmldecode) {
            $$versions{$numver} = $incoming;
        } else {
            $$versions{$numver} = &HTML::Entities::encode($incoming,'<>&"');
        }
    }
    return;
}

sub get_post_attachments {
    my ($attachments,$attachmenturls) = @_;
    my $num;
    if ($attachmenturls =~ m/^<attachment id="0">/) {
        my $p = HTML::LCParser->new(\$attachmenturls);
        while (my $token = $p->get_tag("attachment","filename","post"))  {
            if ($token->[0] eq "attachment") {
                $num = $token->[1]{id};
                %{$$attachments{$num}} =();
            } elsif ($token->[0] eq "filename") {
                $$attachments{$num}{'filename'} = $p->get_text("/filename");
            } elsif ($token->[0] eq "post") {
                my $id = $token->[1]{id};
                $$attachments{$num}{$id} = $p->get_text("/post");
            }
        }
    } else {
        %{$$attachments{'0'}} = ();
        $$attachments{'0'}{'filename'} = $attachmenturls;
        $$attachments{'0'}{'0'} = 'n';
    }

    return;
}

sub fail_redirect {
  my ($r,$feedurl) = @_;
  if ($feedurl=~/^\/adm\//) { $feedurl.='?register=1' };
  my %lt = &Apache::lonlocal::texthash(
                 'sorr' => 'Sorry, no recipients ...',
  );
  my $logo=&Apache::loncommon::lonhttpdurl('/adm/lonIcons/lonlogos.gif');
  $r->print(&Apache::loncommon::start_page('Feedback not sent',undef,
					   {'redirect'  => [2,$feedurl],
					    'only_body' => 1,}));
  $r->print(<<ENDFAILREDIR);
<img align="right" src="$logo" />
<b>$lt{'sorr'}</b>
ENDFAILREDIR
  $r->print(&Apache::loncommon::end_page());
}

sub redirect_back {
  my ($r,$feedurl,$typestyle,$sendsomething,$sendposts,$blog,$status,$previous,$sort,$rolefilter,$statusfilter,$sectionpick,$grouppick,$numpicks,$group,$toolarge) = @_;
  my $sorttag = '';
  my $roletag = '';
  my $statustag = '';
  my $sectag = '';
  my $grptag = '';
  my $userpicktag = '';
  my $qrystr = '';
  my $prevtag = '';

  &Apache::loncommon::content_type($r,'text/html');
  $r->send_http_header;
  &dewrapper(\$feedurl);
  if ($feedurl=~/^\/adm\//) { $feedurl.='?register=1' };
  if ($previous > 0) {
      $qrystr = 'previous='.$previous;
      if ($feedurl =~ /\?register=1/) {
          $feedurl .= '&amp;'.$qrystr;
      } else {
          $feedurl .= '?'.$qrystr;
      }
      $prevtag = '<input type="hidden" name="previous" value="'.$previous.'" />';
  }
  if (defined($sort)) {
      my $sortqry = 'sortposts='.$sort;
      if (($feedurl =~ /\?register=1/) || ($feedurl =~ /\?previous=/)) {
          $feedurl .= '&amp;'.$sortqry;
      } else {
          $feedurl .= '?'.$sortqry;
      }
      $sorttag = '<input type="hidden" name="sortposts" value="'.$sort.'" />';
      if (defined($numpicks)) {
          my $userpickqry = 'totposters='.$numpicks;
          $feedurl .= '&amp;'.$userpickqry;
          $userpicktag = '<input type="hidden" name="totposters" value="'.$numpicks.'" />';
      } else {
          if (ref($sectionpick) eq 'ARRAY') {
              $feedurl .= '&amp;sectionpick=';
              $sectag .=  '<input type="hidden" name="sectionpick" value="';
              foreach my $sec (@{$sectionpick}) {
                  $feedurl .= $sec.',';
                  $sectag .= $sec.',';
              }
              $feedurl =~ s/,$//;
              $sectag =~ s/,$//;
              $sectag .= '" />';
          } else {
              $feedurl .= '&amp;sectionpick='.$sectionpick;
              $sectag = '<input type="hidden" name="sectionpick" value="'.$sectionpick.'" />';
          }
          if (ref($grouppick) eq 'ARRAY') {
              $feedurl .= '&amp;grouppick=';
              $sectag .=  '<input type="hidden" name="grouppick" value="';
              foreach my $grp (@{$grouppick}) {
                  $feedurl .= $grp.',';
                  $grptag .= $grp.',';
              }
              $feedurl =~ s/,$//;
              $grptag =~ s/,$//;
              $grptag .= '" />';
          } else {
              $feedurl .= '&amp;grouppick='.$grouppick;
              $grptag = '<input type="hidden" name="grouppick" value="'.$grouppick.'" />';
          }
          if (ref($rolefilter) eq 'ARRAY') {
              $feedurl .= '&amp;rolefilter=';
              $roletag .=  '<input type="hidden" name="rolefilter" value="';
              foreach my $role (@{$rolefilter}) {
                  $feedurl .= $role.',';
                  $roletag .= $role.',';
              }
              $feedurl =~ s/,$//;
              $roletag =~ s/,$//;
              $roletag .= '" />';
          } else {
              $feedurl .= '&amp;rolefilter='.$rolefilter;
              $roletag = '<input type="hidden" name="rolefilter" value="'.$rolefilter.'" />';
          }
          $feedurl .= '&amp;statusfilter='.$statusfilter;
          $statustag ='<input type="hidden" name="statusfilter" value="'.$statusfilter.'" />';
      }
  }
  my $grouptag;
  if ($group ne '') {
      $grouptag = '<input type="hidden" name="group" value="'.$group.'" />';
      my $refarg;
      if (exists($env{'form.ref'})) {
          $refarg = '&amp;ref='.$env{'form.ref'};
          $grouptag .= '<input type="hidden" name="ref" value="'.$env{'form.ref'}.'" />';
      }
      if ($feedurl =~ /\?/) {
          $feedurl .= '&amp;group='.$group.$refarg;
      } else {
          $feedurl .= '?group='.$group.$refarg;
      }
  } 
  &Apache::lonenc::check_encrypt(\$feedurl);
  my $logo=&Apache::loncommon::lonhttpdurl('/adm/lonIcons/lonlogos.gif');
  my %onload;
  my $start_page=
      &Apache::loncommon::start_page('Feedback sent',undef,
				     {'redirect'    => [0,$feedurl],
				      'only_body'   => 1,
				      'add_entries' => \%onload});
  my $end_page = &Apache::loncommon::end_page();
  $r->print(<<ENDREDIR);
$start_page
<img align="right" src="$logo" />
$typestyle
<b>Sent $sendsomething message(s), and $sendposts post(s).</b>
$blog
$toolarge
<font color="red">$status</font>
<form name="reldt" action="$feedurl" target="loncapaclient">
$prevtag
$sorttag
$statustag
$roletag
$sectag
$grptag
$userpicktag
$grouptag
</form>
$end_page
ENDREDIR
}

sub no_redirect_back {
  my ($r,$feedurl) = @_;
  my $nofeed=&mt('Sorry, no feedback possible on this resource ...');
 
  my %onload;

  my %body_options = ('only_body'   => 1,
		      'bgcolor'     => '#FFFFFF',
		      'add_entries' => \%onload,);

  if ($feedurl !~ m{^/adm/feedback}) { 
      $body_options{'rediect'} = [2,$feedurl];
  }
  my $start_page=
      &Apache::loncommon::start_page('Feedback not sent',undef,
				     \%body_options);
				      
  my $end_page = &Apache::loncommon::end_page();

  &Apache::lonenc::check_encrypt(\$feedurl);
  my $logo=&Apache::loncommon::lonhttpdurl('/adm/lonIcons/lonlogos.gif');
  $r->print (<<ENDNOREDIRTWO);
$start_page
<img align="right" src="$logo" />
<b>$nofeed</b>
<br />
$end_page
ENDNOREDIRTWO
}

sub screen_header {
    my ($feedurl,$symb,$group) = @_;
    my $crscontent = &mt('Question/Comment/Feedback about course content');
    my $crspolicy = &mt('Question/Comment/Feedback about course policy');
    my $contribdisc = &mt('Contribution to course discussion of resource');
    my $anoncontrib = &mt('Anonymous contribution to course discussion of resource');
    my $namevis = &mt('name only visible to course faculty');
    my $crstype;
    if ($env{'request.course.id'}) {
        $crstype = &Apache::loncommon::course_type();
        if ($crstype eq 'Community') {
            $crscontent = &mt('Question/Comment/Feedback about community content');
            $crspolicy = &mt('Question/Comment/Feedback about community policy');
            $contribdisc = &mt('Contribution to community discussion of resource');
            $anoncontrib = &mt('Anonymous contribution to community discussion of resource');
            $namevis = &mt('name only visible to community facilitators');
        }
    }
    my $msgoptions='';
    my $discussoptions='';
    unless (($env{'form.replydisc'}) || ($env{'form.editdisc'})) {
	if (($feedurl=~/^\/res\//) && ($feedurl!~/^\/res\/adm/) && ($env{'user.adv'})) {
	    $msgoptions= 
		'<p><label><input type="radio" name="discuss" value="author" /> '.
		&mt('Feedback to resource author').'</label></p>';
	}
        my %optionhash=();
        foreach my $type ('question','comment','policy') {
	    $optionhash{$type}=$env{'course.'.$env{'request.course.id'}.'.'.$type.'.email.text'};
	}
	if (&feedback_available(1)) {
	    $msgoptions.=
		'<p><label><input type="radio" name="discuss" value="question" /> '.
		($optionhash{'question'}?$optionhash{'question'}:&mt('Question about resource content')).'</label></p>';
	}
	if (&feedback_available(0,1)) {
	    $msgoptions.=
		'<p><label><input type="radio" name="discuss" value="course" /> '.
		($optionhash{'comment'}?$optionhash{'comment'}:$crscontent).
		'</label></p>';
	}
	if (&feedback_available(0,0,1)) {
	    $msgoptions.=
		'<p><label><input type="radio" name="discuss" value="policy" /> '.
		($optionhash{'policy'}?$optionhash{'policy'}:$crspolicy).
		'</label></p>';
	}
    }
    if (($env{'request.course.id'}) && (!$env{'form.sendmessageonly'})) {
        my ($blocked,$blocktext) = &Apache::loncommon::blocking_status('boards');
        my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
        my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
        my $realsymb = $symb;
        if ($symb=~/^bulletin___/) {
            my $filename=(&Apache::lonnet::decode_symb($symb))[2];
            $filename=~s|^adm/wrapper/||;
            $realsymb=&Apache::lonnet::symbread($filename);
        }
        if (!$blocked && &discussion_open(undef,$realsymb) && 
	    (&Apache::lonnet::allowed('pch',
				      $env{'request.course.id'}.
				      ($env{'request.course.sec'}?'/'.$env{'request.course.sec'}:'')) || 
            (($group ne '') && ($symb =~ m{^bulletin___\d+___adm/wrapper/adm/\Q$cdom\E/\Q$cnum\E/\d+/bulletinboard$}) && (&check_group_priv($group,'pgd') eq 'ok')))) {
	    $discussoptions='<label><input type="radio" name="discuss" value="nonanon" checked="checked" /> '.
		$contribdisc.
	        '</label><br /><label><input type="radio" name="discuss" value="anon" /> '.
		$anoncontrib.
		' <i>('.$namevis.')</i></label> '.
		'<a href="/adm/preferences?action=changescreenname">'.&mt('Change Screenname').'</a>';
            my $blockblog = &Apache::loncommon::blocking_status('blogs');
            if (!$blockblog) {
                $discussoptions.= &add_blog_checkbox($crstype);
            }
        }
    }
    if ($msgoptions) {
        $msgoptions='<h2><img src="'.&Apache::loncommon::lonhttpdurl('/res/adm/pages/feedback.png').'" />'
                   .' '.&mt('Send Feedback').'</h2><p>'.&Apache::lonhtmlcommon::coursepreflink(&mt('Feedback Settings'),'feedback').'</p>'
                   .$msgoptions;
    }
    if ($discussoptions) { 
	$discussoptions='<h2><img src="'.&Apache::loncommon::lonhttpdurl('/adm/lonMisc/chat.gif').'" alt="" />'
                        .' '.&mt('Discussion Contributions').'</h2><p>'.&Apache::lonhtmlcommon::coursepreflink(&mt('Discussion Settings'),'discussion').'</p>'
                        .$discussoptions;
    }
    return $msgoptions.$discussoptions;
}

sub resource_output {
  my ($feedurl) = @_;
  my $usersaw=&Apache::lonnet::ssi_body($feedurl);
  $usersaw=~s/\<body[^\>]*\>//gi;
  $usersaw=~s/\<\/body\>//gi;
  $usersaw=~s/\<html\>//gi;
  $usersaw=~s/\<\/html\>//gi;
  $usersaw=~s/\<head\>//gi;
  $usersaw=~s/\<\/head\>//gi;
  $usersaw=~s/action\s*\=/would_be_action\=/gi;
  return $usersaw;
}

sub clear_out_html {
  my ($message,$override)=@_;
# Always allow the <m>-tag
  my %html=(M=>1);
# Check if more is allowed
  my $cid=$env{'request.course.id'};
  if (($env{"course.$cid.allow_limited_html_in_feedback"} =~ m/yes/i) ||
      ($override)) {
      # allows <B> <I> <P> <A> <LI> <OL> <UL> <EM> <BR> <TT> <STRONG> 
      # <BLOCKQUOTE> <DIV .*> <DIV> <IMG> <M> <SPAN> <H1> <H2> <H3> <H4> <SUB>
      # <SUP> <TABLE> <TR> <TD> <TH> <TBODY>
      %html=(B=>1, I=>1, P=>1, A=>1, LI=>1, OL=>1, UL=>1, EM=>1,
	     BR=>1, TT=>1, STRONG=>1, BLOCKQUOTE=>1, PRE=>1, DIV=>1, IMG=>1,
	     M=>1, CHEM=>1, ALGEBRA=>1, SUB=>1, SUP=>1, SPAN=>1,  
	     H1=>1, H2=>1, H3=>1, H4=>1, H5=>1, H6=>1, 
	     TABLE=>1, TR=>1, TD=>1, TH=>1, TBODY=>1);
  }
# Do the substitution of everything that is not explicitly allowed
  $message =~ s/\<(\/?\s*(\w+)[^\>\<]*)/
	  {($html{uc($2)}&&(length($1)<1000))?"\<$1":"\&lt;$1"}/ge;
  $message =~ s/(\<?\s*(\w+)[^\<\>]*)\>/
	  {($html{uc($2)}&&(length($1)<1000))?"$1\>":"$1\&gt;"}/ge;
  return $message;
}

sub assemble_email {
  my ($message,$prevattempts,$usersaw,$useranswer)=@_;
  my %lt = &Apache::lonlocal::texthash(
             'prev' => 'Previous attempts of student (if applicable)',
             'orig' => 'Original screen output (if applicable)',
             'corr' => 'Correct Answer(s) (if applicable)',
  );
  if (&Apache::loncommon::course_type() eq 'Community') {
      $lt{'prev'} = &mt('Previous attempts of member (if applicable)');
  }
  my $email=<<"ENDEMAIL";
$message
ENDEMAIL
    my $citations=<<"ENDCITE";
<h2>$lt{'prev'}</h2>
$prevattempts
<br /><hr />
<h2>$lt{'orig'}</h2>
$usersaw
<h2>$lt{'corr'}</h2>
$useranswer
ENDCITE
  return ($email,$citations);
}


sub feedback_available {
    my ($question,$course,$policy)=@_;
    my ($typestyle,%to)=&Apache::lonmsg::decide_receiver('',0,$question,
							 $course,$policy);
    return scalar(%to);
}

sub send_msg {
    my ($title,$feedurl,$email,$citations,$attachmenturl,$symb,%to)=@_;
    my $status='';
    my $sendsomething=0;
    my $restitle = &get_resource_title($symb,$feedurl);
    if ($title=~/^Error/) { $title=&mt('Feedback').': '.$title; }
    unless ($title=~/\w/) { $title=&mt('Feedback'); }
    foreach my $key (keys(%to)) {
	if ($key) {
	    my ($user,$domain) = split(/\:/,$key,2);
	    if (!defined($user)) {
		$status.='<br />'.&mt('Error sending message to [_1], no user specified.',$key);
	    } elsif (!defined($domain)) {
		$status.='<br />'.&mt('Error sending message to [_1], no domain specified.',$key);
	    } else {
		unless (&Apache::lonmsg::user_normal_msg($user,$domain,
							 $title.' ['.$restitle.']',$email,$citations,$feedurl,
							 $attachmenturl,undef,undef,$symb,$restitle)=~/ok/) {
		    $status.='<br />'.&mt('Error sending message to').' '.$key.'<br />';
		} else {
		    $sendsomething++;
		}
	    }
	}
    }


    my %record=&Apache::lonnet::restore('_feedback');
    my ($temp)=keys(%record);
    unless ($temp=~/^error\:/) {
	my %newrecord=();
	$newrecord{'resource'}=$feedurl;
	$newrecord{'subnumber'}=$record{'subnumber'}+1;
	unless (&Apache::lonnet::cstore(\%newrecord,'_feedback') eq 'ok') {
	    $status.='<br />'.&mt('Not registered').'<br />';
	}
    }
    
    return ($status,$sendsomething);
}

sub adddiscuss {
    my ($symb,$email,$anon,$attachmenturl,$subject,$group)=@_;
    my $status='';
    my $realsymb;
    if ($symb=~/^bulletin___/) {
	my $filename=(&Apache::lonnet::decode_symb($symb))[2];
	$filename=~s|^adm/wrapper/||;
	$realsymb=&Apache::lonnet::symbread($filename);
    }
    my ($cnum,$cdom);
    if ($env{'request.course.id'}) {
        $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
        $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
    }
    if (&discussion_open(undef,$realsymb) &&
	(&Apache::lonnet::allowed('pch',$env{'request.course.id'}.
         ($env{'request.course.sec'}?'/'.$env{'request.course.sec'}:'')) || 
         (($group ne '') && (&check_group_priv($group,'pgd') eq 'ok') && 
         ($symb =~ m{^bulletin___\d+___adm/wrapper/adm/\Q$cdom\E/\Q$cnum\E/\d+/bulletinboard$})))) {

    my %contrib=('message'      => $email,
                 'sendername'   => $env{'user.name'},
                 'senderdomain' => $env{'user.domain'},
                 'screenname'   => $env{'environment.screenname'},
                 'plainname'    => $env{'environment.firstname'}.' '.
		                   $env{'environment.middlename'}.' '.
                                   $env{'environment.lastname'}.' '.
                                   $env{'enrironment.generation'},
                 'attachmenturl'=> $attachmenturl,
                 'subject'      => $subject);
    if ($env{'form.replydisc'}) {
	$contrib{'replyto'}=(split(/\:\:\:/,$env{'form.replydisc'}))[1];
    }
    if ($anon) {
	$contrib{'anonymous'}='true';
    }
    if (($symb) && ($email)) {
        my $now = time;
        if ($env{'form.editdisc'}) {
            $contrib{'ip'}=$ENV{'REMOTE_ADDR'};
            $contrib{'host'}=$Apache::lonnet::perlvar{'lonHostID'};
            $contrib{'timestamp'} = $now;
            $contrib{'history'} = '';
            my $numoldver = 0;
            my ($oldsymb,$oldidx)=split(/\:\:\:/,$env{'form.editdisc'});
	    &Apache::lonenc::check_decrypt(\$oldsymb);
            $oldsymb=~s|(bulletin___\d+___)adm/wrapper/|$1|;
# get timestamp for last post and history
            my %oldcontrib=&Apache::lonnet::restore($oldsymb,$env{'request.course.id'},
                     $env{'course.'.$env{'request.course.id'}.'.domain'},
                     $env{'course.'.$env{'request.course.id'}.'.num'});
            if (defined($oldcontrib{$oldidx.':replyto'})) {
                $contrib{'replyto'} = $oldcontrib{$oldidx.':replyto'};
            }
            if (defined($oldcontrib{$oldidx.':history'})) {
                if ($oldcontrib{$oldidx.':history'} =~ /:/) {
                    my @oldversions = split(/:/,$oldcontrib{$oldidx.':history'});
                    $numoldver = @oldversions;
                } else {
                    $numoldver = 1;
                }
                $contrib{'history'} = $oldcontrib{$oldidx.':history'}.':';
            }
            my $numnewver = $numoldver + 1;
            if (defined($oldcontrib{$oldidx.':subject'})) {
                if ($oldcontrib{$oldidx.':subject'} =~ /^<version num="0">/) {
                    $contrib{'subject'} = '<version num="'.$numnewver.'">'.&HTML::Entities::encode($contrib{'subject'},'<>&"').'</version>';
                    $contrib{'subject'} = $oldcontrib{$oldidx.':subject'}.$contrib{'subject'};
                } else {
                    $contrib{'subject'} = '<version num="0">'.&HTML::Entities::encode($oldcontrib{$oldidx.':subject'},'<>&"').'</version><version num="1">'.&HTML::Entities::encode($contrib{'subject'},'<>&"').'</version>';
                }
            } 
            if (defined($oldcontrib{$oldidx.':message'})) {
                if ($oldcontrib{$oldidx.':message'} =~ /^<version num="0">/) {
                    $contrib{'message'} = '<version num="'.$numnewver.'">'.&HTML::Entities::encode($contrib{'message'},'<>&"').'</version>';
                    $contrib{'message'} = $oldcontrib{$oldidx.':message'}.$contrib{'message'};
                } else {
                    $contrib{'message'} = '<version num="0">'.&HTML::Entities::encode($oldcontrib{$oldidx.':message'},'<>&"').'</version><version num="1">'.&HTML::Entities::encode($contrib{'message'},'<>&"').'</version>';
                }
            }
            $contrib{'history'} .= $oldcontrib{$oldidx.':timestamp'};
            my $put_reply = &Apache::lonnet::putstore($env{'request.course.id'},
                  $oldsymb,$oldidx,\%contrib,
                  $env{'course.'.$env{'request.course.id'}.'.domain'},
                  $env{'course.'.$env{'request.course.id'}.'.num'});
            $status='Editing class discussion'.($anon?' (anonymous)':'');
        } else {
           $status='Adding to class discussion'.($anon?' (anonymous)':'').': '.
           &Apache::lonnet::store(\%contrib,$symb,$env{'request.course.id'},
                     $env{'course.'.$env{'request.course.id'}.'.domain'},
		     $env{'course.'.$env{'request.course.id'}.'.num'});
#generate a new feed entry
           my $course_id = $env{'request.course.id'};
           my $course_title = $env{'course.'.$course_id.'.description'};
           my $updated = DateTime->now();
           my $author = $anon ? 'anonymous' : $contrib{'sendername'};
           my $title = $contrib{'subject'};
           my %posts = &Apache::lonnet::restore($symb,$course_id, $env{'course.'.$course_id.'.domain'}, $env{'course.'.$course_id.'.num'});
           my $idx = $posts{'version'};
           my $id = $symb.':::'.$idx;
           &Apache::lonfeeds::new_entry($course_id, 'discussion', $course_title, $id, $title, '', $author, $updated, $symb, '');
        }
        my %storenewentry=($symb => $now);
        $status.='<br />'.&mt('Updating discussion time').': '.
        &Apache::lonnet::put('discussiontimes',\%storenewentry,
                     $env{'course.'.$env{'request.course.id'}.'.domain'},
		     $env{'course.'.$env{'request.course.id'}.'.num'});
    }
    my %record=&Apache::lonnet::restore('_discussion');
    my ($temp)=keys(%record);
    unless ($temp=~/^error\:/) {
       my %newrecord=();
       $newrecord{'resource'}=$symb;
       $newrecord{'subnumber'}=$record{'subnumber'}+1;
       $status.='<br />'.&mt('Registering').': '.
               &Apache::lonnet::cstore(\%newrecord,'_discussion');
    }
    } else {
	$status.='Failed.';
    }
    return $status.'<br />';   
}

sub get_discussion_info {
    my ($idx,%contrib) = @_;
    my $changelast = 0;
    my $count = 0;
    my $hiddenflag = 0;
    my $deletedflag = 0;
    my ($hidden,$deleted,%info,$newlastdisc);
    my $version = $contrib{'version'};
    if ($version) {
        for (my $id=$version; $id>0; $id--) {
            my $vkeys=$contrib{$id.':keys'};
            my @keys=split(/:/,$vkeys);
            if (grep(/^hidden$/,@keys)) {
                if (!$hiddenflag) {
                    $hidden = $contrib{$id.':hidden'};
                    $hiddenflag = 1;
                }
            } elsif (grep(/^deleted$/,@keys)) {
                if (!$deletedflag) {
                    $deleted = $contrib{$id.':deleted'};
                    $deletedflag = 1;
                }
            } else {
                if (($hidden !~/\.$id\./) && ($deleted !~/\.$id\./)) {
                    $count++;
                    $info{$count}{'id'} = $id;
                    $info{$count}{'timestamp'}=$contrib{$id.':timestamp'}; 
                }
            }
        }
        if ($info{'1'}{'id'} == $idx) {
            $changelast = 1;
            if ($count > 1) { 
                $newlastdisc =  $info{'2'}{'timestamp'};
            } else {
                $newlastdisc = 0;
            }
        }
    }
    return ($changelast,$newlastdisc);
}

# ----------------------------------------------------------- Preview function

sub show_preview {
    my ($r) = @_;
    &Apache::loncommon::content_type($r,'text/html');
    $r->send_http_header;
    my $start_page=
	&Apache::loncommon::start_page('Preview',undef,
				       {'only_body'   => 1,});

    my $message=&clear_out_html($env{'form.comment'});
    &newline_to_br(\$message);
    $message=&Apache::lonspeller::markeduptext($message);
    $message=&Apache::lontexconvert::msgtexconverted($message);
    my $subject=&clear_out_html($env{'form.subject'});
    $subject=~s/\n/\<br \/\>/g;
    $subject=&Apache::lontexconvert::msgtexconverted($subject);
					
    my $end_page = &Apache::loncommon::end_page();

    $r->print($start_page
             .'<h1>'.&mt('Preview').'</h1>'
             .&Apache::lonhtmlcommon::start_pick_box()
             .&Apache::lonhtmlcommon::row_title(&mt('Subject'))
             .$subject
             .&Apache::lonhtmlcommon::row_closure()
             .&Apache::lonhtmlcommon::row_title(&mt('Message'))
             .$message
             .&Apache::lonhtmlcommon::row_closure(1)
             .&Apache::lonhtmlcommon::end_pick_box()
             .$end_page
    );
}

sub contains_block_html {
    my ($message)=@_;
    return ($message =~ m{
        <(br|h1|h2|h3|h4|h5|h6|p|ol|ul|table|pre|address|blockquote|center|div) 
	  \s*
	 (\w+\=['"]\w+['"])*
	  \s*
	(
	  \s*/>|
	  >.*</\1\s*>
	)}xs 
    );
}

sub tidy_html {
	my ($message)=@_;
# 	my $tidy = HTML::Tidy::libXML->new();
# 	my $xhtml = $tidy->clean($message, 'utf-8', 1);
# 	$xhtml =~ m/<body>(.*)<\/body>/is;
# 	my $clean = $1;
# 	# remove any empty block-level tags
# 	$clean =~ s/<(table|p|div|tbody|blockquote|m|pre|algebra|center|ol|ul|span|h1|h2|h3|h4|h5|h6)\s*\/>//i;
# 	$message=$clean;
	return $message;
}

sub newline_to_br {
    my ($message)=@_;
    my $newmessage;
    my $parser=HTML::LCParser->new($message);
    while (my $token=$parser->get_token()) {
	if ($token->[0] eq 'T') {
	    my $text=$token->[1];
	    $text=~s/\n/\<br \/\>/g;
	    $newmessage.=$text;
	} elsif ($token->[0] eq 'D' || $token->[0] eq 'C') {
	    $newmessage.=$token->[1];
	} elsif ($token->[0] eq 'PI' || $token->[0] eq 'E') {
	    $newmessage.=$token->[2];
	} elsif ($token->[0] eq 'S') {
	    $newmessage.=$token->[4];
	}
	    
    }
    $$message=$newmessage;
}

sub generate_preview_button {
    my ($formname,$fieldname)=@_;
    unless ($formname) { $formname='mailform'; }
    unless ($fieldname) { $fieldname='comment'; }
    my $pre=&mt("Show Preview and Check Spelling");
    return(<<ENDPREVIEW);
<br />
<form name="preview" action="/adm/feedback?preview=1" method="post" target="preview">
<input type="hidden" name="subject" />
<input type="hidden" name="comment" />
<input type="button" value="$pre"
onclick="if (typeof(document.$formname.onsubmit)=='function') {document.$formname.onsubmit();};this.form.comment.value=document.$formname.$fieldname.value;this.form.subject.value=document.$formname.subject.value;this.form.submit();" />
</form>
ENDPREVIEW
}

sub modify_attachments {
    my ($r,$currnewattach,$currdelold,$symb,$idx,$attachmenturls,
        $attachmaxtext,$toolarge)=@_;

    my %lt = &Apache::lonlocal::texthash(
               'subj' => 'Subject',
               'thfo' => 'The following attachments were part of the most recent saved version of this posting.',
               'chth' => 'Check the checkboxes for any you wish to remove.',
               'thef' => 'The following attachments have been uploaded for inclusion with this posting.',
               'adda' => 'Add a new attachment to this post.',
               'stch' => 'Save Changes',
             );
    my $js = <<END;
<script type="text/javascript">
 function setAction () {
   document.modattachments.action = document.modattachments.origpage.value;
   document.modattachments.submit();
 }
</script> 
END

    # Breadcrumbs
    my $brcrum = [{'href' => '',
                   'text' => 'Discussion Post Attachments'}];
    my $start_page = 
	&Apache::loncommon::start_page('Discussion Post Attachments',$js,
                                   {'bread_crumbs' => $brcrum,});

    my $orig_subject = &unescape($env{'form.subject'});
    my $subject=&clear_out_html($orig_subject);
    $subject=~s/\n/\<br \/\>/g;
    $subject=&Apache::lontexconvert::msgtexconverted($subject);
    my $timestamp=$env{'form.timestamp'};
    my $numoldver=$env{'form.numoldver'};

    my $msg = '';
    my %attachments = ();
    my %currattach = ();
    if ($idx) {
        &extract_attachments($attachmenturls,$idx,$numoldver,\$msg,\%attachments,\%currattach,$currdelold);
    }
    &Apache::lonenc::check_encrypt(\$symb);

    my $end_page = 
	&Apache::loncommon::end_page();
				       
    $r->print(<<END);
$start_page
$toolarge
<form name="modattachments" method="post" enctype="multipart/form-data" action="/adm/feedback?attach=$symb">
 <br />
 <table class="LC_data_table">
  <tr>
   <td colspan="2">
    <b>Subject:</b> <b>$subject</b><br /><br />
END
    if ($idx) {
        if ($attachmenturls) {
            my @currold = keys(%currattach);
            if (@currold > 0) {
                $r->print($lt{'thfo'}.'<br />'.$lt{'chth'}.'<br />'."\n");  
                foreach my $id (@currold) {
                    my $attachurl = &HTML::Entities::decode($attachments{$id}{'filename'}); 
                    $attachurl =~ m#/([^/]+)$#;
                    $r->print('<label><input type="checkbox" name="deloldattach" value="'.$id.'" />&nbsp;'.$1.'</label><br />'."\n");
                }
                $r->print("<br />");
            }
        }
    }
    if ((ref($currnewattach) eq 'ARRAY') && (@{$currnewattach} > 0)) {
        $r->print($lt{'thef'}.'<br />'.$lt{'chth'}.'<br />'."\n");
        foreach my $attach (@{$currnewattach}) {
            $attach =~ m#/([^/]+)$#;
            $r->print('<label><input type="checkbox" name="delnewattach" value="'.$attach.'" />&nbsp;'.$1.'</label><br />'."\n");
        }
        $r->print("<br />"); 
    }
    $r->print(<<END);
   </td></tr>
   <tr>
    <td>
   $lt{'adda'}</td><td><input type="file" name="addnewattach" /><input type="button" name="upload" value="Upload" onclick="this.form.submit()" />    
   </td>
  </tr>
  <tr>
   <td colspan="2">$attachmaxtext</td>
  </tr>
 </table>
<input type="hidden" name="subject" value="$env{'form.subject'}" />
<input type="hidden" name="comment" value="$env{'form.comment'}" />
<input type="hidden" name="timestamp" value="$env{'form.timestamp'}" />
<input type="hidden" name="idx" value="$env{'form.idx'}" />
<input type="hidden" name="numoldver" value="$env{'form.numoldver'}" />
<input type="hidden" name="origpage" value="$env{'form.origpage'}" />
<input type="hidden" name="blog" value="$env{'form.blog'}" />
<input type="hidden" name="discuss" value="$env{'form.discuss'}" />
END
    foreach my $item (@{$currnewattach}) {
        $r->print('<input type="hidden" name="currnewattach" value="'.$item.'" />'."\n");
    }
    foreach my $item (@{$currdelold}) {
        $r->print('<input type="hidden" name="deloldattach" value="'.$item.'" />'."\n");
    }
    $r->print(<<END);
 <input type="button" name="rtntoedit" value="$lt{'stch'}" onclick="setAction()" />
</form>
$end_page
END
    return;
}

sub process_attachments {
    my ($currnewattach,$currdelold,$keepold) = @_;

    @{$currnewattach}=
	&Apache::loncommon::get_env_multiple('form.currnewattach');
    @{$currdelold}=
	&Apache::loncommon::get_env_multiple('form.deloldattach');
    if (exists($env{'form.delnewattach'})) {
        my @currdelnew =
	    &Apache::loncommon::get_env_multiple('form.delnewattach');
        my @currnew = ();
        foreach my $newone (@{$currnewattach}) {
            my $delflag = 0;
            foreach my $item (@currdelnew) {
                if ($newone eq $item) {
                    $delflag = 1;
                    last;
                }
            }
            unless ($delflag) {
                push(@currnew, $newone);
            }
        }
        @{$currnewattach} = @currnew;
    }
    @{$keepold} = &Apache::loncommon::get_env_multiple('form.keepold');
}

sub generate_attachments_button {
    my ($idx,$attachnum,$ressymb,$now,$currnewattach,$deloldattach,
        $numoldver,$mode,$blockblog) = @_;
    my $origpage = $ENV{'REQUEST_URI'};
    my $att=$attachnum.' '.&mt("attachments");
    my %lt = &Apache::lonlocal::texthash(
                'clic' => 'Click to add/remove attachments',
    ); 
    my $response = (<<END);
<br />
<form name="attachment" action="/adm/feedback?attach=$ressymb" method="post">
$lt{'clic'}:&nbsp;<input type="button" value="$att"
onclick="if (typeof(document.mailform.onsubmit)=='function') {document.mailform.onsubmit();};this.form.comment.value=escape(document.mailform.comment.value);this.form.subject.value=escape(document.mailform.subject.value);
END
    if (!$blockblog) {
        $response .= 'setblogvalue();';
    }
    unless ($mode eq 'board') {
        $response .= 'javascript:anonchk();';
    }
    $response .= (<<ENDATTACH);
this.form.submit();" />
<input type="hidden" name="origpage" value="$origpage" />
<input type="hidden" name="idx" value="$idx" />
<input type="hidden" name="timestamp" value="$now" />
<input type="hidden" name="subject" />
<input type="hidden" name="comment" />
<input type="hidden" name="blog" value="0" />
<input type="hidden" name="discuss" value="0" />
<input type="hidden" name="numoldver" value="$numoldver" />
ENDATTACH
    if (defined($deloldattach)) {
        if (@{$deloldattach} > 0) {
            foreach my $delatt (@{$deloldattach}) {
                $response .= '<input type="hidden" name="deloldattach" value="'.$delatt.'" />'."\n";
            }
        }
    }
    if (defined($currnewattach)) {
        if (@{$currnewattach} > 0) {
            foreach my $attach (@{$currnewattach}) {
                $response .= '<input type="hidden" name="currnewattach" value="'.$attach.'" />'."\n";
            }
        }
    }
    $response .= '</form>';
    return $response;
}

sub extract_attachments {
    my ($attachmenturls,$idx,$numoldver,$message,$attachments,$currattach,$currdelold) = @_;
    %{$attachments}=();
    &get_post_attachments($attachments,$attachmenturls);
    foreach my $id (sort(keys(%{$attachments}))) {
        if (exists($$attachments{$id}{$numoldver})) {
            if (defined($currdelold)) {
                if (@{$currdelold} > 0) {
                    unless (grep/^$id$/,@{$currdelold}) {
                        $$currattach{$id} = $$attachments{$id}{$numoldver}; 
                    }
                } else {
                    $$currattach{$id} = $$attachments{$id}{$numoldver};
                }
            } else {
                $$currattach{$id} = $$attachments{$id}{$numoldver};
            }
        }
    }
    my @attached = (sort { $a <=> $b } keys(%{$currattach}));
    if (@attached == 1) {
        my $id = $attached[0];
        my $attachurl;
        if ($attachmenturls =~ m/^<attachment id="0">/) {
            $attachurl = &HTML::Entities::decode($$attachments{$id}{'filename'});
        } else {
            $attachurl = $$attachments{$id}{'filename'};
        }
        $attachurl=~m|/([^/]+)$|;
        $$message.='<br /><a href="'.$attachurl.'"><tt>'.
        $1.'</tt></a><br />';
        &Apache::lonnet::allowuploaded('/adm/feedback',
                               $attachurl);
    } elsif (@attached > 1) {
        $$message.='<ol>';
        foreach my $attach (@attached) {
            my $id = $attach;
            my $attachurl = &HTML::Entities::decode($$attachments{$id}{'filename'});
            my ($fname)
              =($attachurl=~m|/([^/]+)$|);
            $$message .= '<li><a href="'.$attachurl.
              '"><tt>'.
              $fname.'</tt></a></li>';
            &Apache::lonnet::allowuploaded('/adm/feedback',
                             $attachurl);
        }
        $$message .= '</ol>';
    }
}

sub construct_attachmenturl {
    my ($currnewattach,$keepold,$symb,$idx)=@_;
    my $oldattachmenturl;
    my $newattachmenturl;
    my $startnum = 0;
    my $currver = 0;
    if (($env{'form.editdisc'}) && ($idx)) {
        my %contrib=&Apache::lonnet::restore($symb,$env{'request.course.id'},
                       $env{'course.'.$env{'request.course.id'}.'.domain'},
                       $env{'course.'.$env{'request.course.id'}.'.num'});
        $oldattachmenturl = $contrib{$idx.':attachmenturl'};
        if ($contrib{$idx.':history'}) {
            if ($contrib{$idx.':history'} =~ /:/) {
                my @oldversions = split(/:/,$contrib{$idx.':history'});
                $currver = 1 + scalar(@oldversions);
            } else {
                $currver = 2;
            }
        } else {
            $currver = 1;
        }
        if ($oldattachmenturl) {
            if ($oldattachmenturl =~ m/^<attachment id="0">/) {
                my %attachments = ();
                my $prevver = $currver-1;
                &get_post_attachments(\%attachments,$oldattachmenturl);
                my $numattach = scalar(keys(%attachments));
                $startnum += $numattach;
                foreach my $num (sort {$a <=> $b} keys(%attachments)) {
                    $newattachmenturl .= '<attachment id="'.$num.'"><filename>'.$attachments{$num}{'filename'}.'</filename>';
                    foreach my $item (sort {$a <=> $b} keys(%{$attachments{$num}})) {
                        unless ($item eq 'filename') {
                            $newattachmenturl .= '<post id="'.$item.'">'.$attachments{$num}{$item}.'</post>';
                        }
                    }
                    if (grep/^$num$/,@{$keepold}) {
                        $newattachmenturl .= '<post id="'.$currver.'">'.$attachments{$num}{$prevver}.'</post>';
                    }
                    $newattachmenturl .= '</attachment>';
                }
            } else {
                $newattachmenturl = '<attachment id="0"><filename>'.&HTML::Entities::encode($oldattachmenturl).'</filename><post id="0">n</post>';
                unless (grep/^0$/,@{$keepold}) {
                    $newattachmenturl .= '<post id="1">n</post>';
                }
                $newattachmenturl .= '</attachment>';
                $startnum ++;
            }
        }
    }
    for (my $i=0; $i<@{$currnewattach}; $i++) {
        my $attachnum = $startnum + $i;
        $newattachmenturl .= '<attachment id="'.$attachnum.'"><filename>'.&HTML::Entities::encode($$currnewattach[$i]).'</filename><post id="'.$currver.'">n</post></attachment>';
    }
    return $newattachmenturl; 
}

sub add_blog_checkbox {
    my ($crstype) = @_;
    my $checkstatus;
    if ($env{'form.blog'}) {
        $checkstatus = 'checked="checked"';
    }
    my $output = '
<script type="text/javascript">
function setblogvalue() {
    if (document.mailform.blog.checked) {
        document.attachment.blog.value = 1;
    } else {
        document.attachment.blog.value = 0;
    }
}
</script><br />
<label><input type="checkbox" name="blog" '.$checkstatus.' /> ';
    if ($crstype eq 'Community') {
        $output .= &mt('Add to my public community blog');
    } else {
        $output .= &mt('Add to my public course blog');
    } 
    $output .= '</label><br />'."\n";
    return $output;
}

sub has_discussion {
    my $resourcesref = shift;
    my $navmap = Apache::lonnavmaps::navmap->new();
    if (defined($navmap)) {
        my @allres=$navmap->retrieveResources();
        foreach my $resource (@allres) {
            if ($resource->hasDiscussion()) {
                my $ressymb = $resource->wrap_symb();
                if (ref($resourcesref) eq 'ARRAY') {
                    push(@{$resourcesref}, $ressymb);
                }
            }
        }
    } else {
        &Apache::lonnet::logthis('Has discussion check failed - could not create navmap object.');
    }
    return;
}

sub sort_filter_names {
    my ($sort_types,$role_types,$status_types,$crstype) = @_;
    if (ref($sort_types) eq 'HASH') {
        %{$sort_types} = (
                     ascdate => 'Date order - oldest first',
                     descdate => 'Date order - newest first',
                     thread => 'Threaded',
                     subject => 'By subject',
                     username => 'By domain and username',
                     lastfirst => 'By last name, first name'
                   );
    }
    my @courseroles = qw(st in ta ep ad);
    if ($crstype eq 'Community') {
        push(@courseroles,'co');
    } else {
        push(@courseroles,'cc');
    }
    if (ref($role_types) eq 'HASH') {
        foreach my $role (@courseroles) {
            $role_types->{$role} = &Apache::lonnet::plaintext($role,$crstype);
        }
        $role_types->{'all'} = 'All roles';
        $role_types->{'cr'} = 'Custom role';
    }
    if (ref($status_types) eq 'HASH') {
        %{$status_types} = (
                     all     => 'Roles of any status',
                     Active  => 'Only active roles',
                     Expired => 'Only past roles',
                     Future  => 'Only future roles',
                   );
    }
}
  
sub handler {
  my $r = shift;
  if ($r->header_only) {
     &Apache::loncommon::content_type($r,'text/html');
     $r->send_http_header;
     return OK;
  }

# --------------------------- Get query string for limited number of parameters

  &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},
         ['hide','unhide','deldisc','postdata','preview','replydisc','editdisc','cmd','symb','onlyunread','allposts','onlyunmark','previous','markread','markonread','markondisp','toggoff','toggon','modifydisp','changes','navtime','navmaps','navurl','sortposts','applysort','rolefilter','statusfilter','sectionpick','groupick','posterlist','userpick','attach','origpage','currnewattach','deloldattach','keepold','allversions','export','sendmessageonly','group','ref']);
  my $group = $env{'form.group'};
  my %attachmax = (
                    text => &mt('(128 KB max size)'),
                    num  => 131072,
                  );
  if ($env{'form.editdisc'}) {
      if (!(&editing_allowed($env{'form.editdisc'},$env{'form.group'}))) {
          my $symb=(split(/\:\:\:/,$env{'form.editdisc'}))[0];
          my ($map,$id,$url)=&Apache::lonnet::decode_symb($symb);
          my $feedurl=&Apache::lonnet::clutter($url);
          &redirect_back($r,$feedurl,&mt('Editing not permitted').'<br />',                     '0','0','','',$env{'form.previous'},undef,undef,undef,
                    undef,undef,undef,$group);
          return OK;
      }
  } 
  if ($env{'form.discsymb'}) {
      my ($symb,$feedurl) = &get_feedurl_and_clean_symb($env{'form.discsymb'});
      my $readkey = $symb.'_read';
      my $chgcount = 0;
      my %readinghash = &Apache::lonnet::get('nohist_'.$env{'request.course.id'}.'_discuss',[$readkey],$env{'user.domain'},$env{'user.name'});
      foreach my $key (keys(%env)) {
          if ($key =~ m/^form\.postunread_(\d+)/) {
              if ($readinghash{$readkey} =~ /\.$1\./) {
                  $readinghash{$readkey} =~ s/\.$1\.//;
                  $chgcount ++;
              }
          } elsif ($key =~ m/^form\.postread_(\d+)/) {
              unless ($readinghash{$readkey} =~ /\.$1\./) {
                  $readinghash{$readkey} .= '.'.$1.'.';
                  $chgcount ++;
              }
          }
      }
      if ($chgcount > 0) {
          &Apache::lonnet::put('nohist_'.$env{'request.course.id'}.'_discuss',
			  \%readinghash,$env{'user.domain'},$env{'user.name'});
      }
      &redirect_back($r,$feedurl,&mt('Marked postings read/unread').'<br />',
		     '0','0','','',$env{'form.previous'},'','','',
                     undef,undef,undef,$group);
      return OK;
  }
  if ($env{'form.allversions'}) {
      &Apache::loncommon::content_type($r,'text/html');
      &Apache::loncommon::no_cache($r);
      $r->send_http_header;

      # Breadcrumbs
      my $brcrum = [{'href' => '',
                     'text' => 'Discussion Post Versions'}];

      $r->print(&Apache::loncommon::start_page('Discussion Post Versions',undef,
                                               {'bread_crumbs' => $brcrum,})
      );

      my $crs='/'.$env{'request.course.id'};
      if ($env{'request.course.sec'}) {
          $crs.='_'.$env{'request.course.sec'};
      }
      $crs=~s|_|/|g;
      my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
      my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
      my ($symb,$idx)=split(/\:\:\:/,$env{'form.allversions'});
      ($symb)=&get_feedurl_and_clean_symb($symb);
      my $ressymb = &wrap_symb($symb);
      my $group = $env{'form.group'};
      my $seeid;
      if (($group ne '') && (($ressymb =~ m|^bulletin___\d+___adm/wrapper/adm/\Q$cdom\E/\Q$cnum\E/\d+/bulletinboard$|))) {
          if (&check_group_priv($group,'dgp') eq 'ok') {
              $seeid = 1;
          }
      } else {
          $seeid = &Apache::lonnet::allowed('rin',$crs);
      }
      if ($idx > 0) {
          my %messages = ();
          my %subjects = ();
          my %attachmsgs = ();
          my %allattachments = ();
          my %imsfiles = ();
          my ($screenname,$plainname);
          my %contrib=&Apache::lonnet::restore($symb,$env{'request.course.id'},
                           $env{'course.'.$env{'request.course.id'}.'.domain'},
                           $env{'course.'.$env{'request.course.id'}.'.num'});
          $r->print(&get_post_contents(\%contrib,$idx,$seeid,'allversions',\%messages,\%subjects,\%allattachments,\%attachmsgs,\%imsfiles,\$screenname,\$plainname));
      }
      $r->print(&Apache::loncommon::end_page());
      return OK;
  }
  if ($env{'form.posterlist'}) {
      my ($symb,$feedurl)=&get_feedurl_and_clean_symb($env{'form.applysort'});
      &print_showposters($r,$symb,$env{'form.previous'},$feedurl,
			 $env{'form.sortposts'});
      return OK;
  }
  if ($env{'form.userpick'}) {
      my @posters = &Apache::loncommon::get_env_multiple('form.stuinfo');
      my ($symb,$feedurl)=&get_feedurl_and_clean_symb($env{'form.userpick'});
      my $numpicks = @posters;
      my %discinfo;
      $discinfo{$symb.'_userpick'} = join('&',@posters);
      &Apache::lonnet::put('nohist_'.$env{'request.course.id'}.'_discuss',
			   \%discinfo,$env{'user.domain'},$env{'user.name'});
      &redirect_back($r,$feedurl,&mt('Changed sort/filter').'<br />','0','0','',
		     '',$env{'form.previous'},$env{'form.sortposts'},'','','',
		     '',$numpicks,$group);
      return OK;
  }
  if ($env{'form.applysort'}) {
      my ($symb,$feedurl)=&get_feedurl_and_clean_symb($env{'form.applysort'});
      &redirect_back($r,$feedurl,&mt('Changed sort/filter').'<br />','0','0','',
		     '',$env{'form.previous'},$env{'form.sortposts'},
		     $env{'form.rolefilter'},$env{'form.statusfilter'},
		     $env{'form.sectionpick'},$env{'form.grouppick'},
                     undef,$group);
      return OK;
  } elsif ($env{'form.cmd'} eq 'sortfilter') {
      my ($symb,$feedurl)=&get_feedurl_and_clean_symb($env{'form.symb'});
      &print_sortfilter_options($r,$symb,$env{'form.previous'},$feedurl);
      return OK;
  } elsif ($env{'form.navtime'}) {
      my %discinfo = ();
      my @resources = ();
      if (defined($env{'form.navmaps'})) {
          if ($env{'form.navmaps'} =~ /:/) {
              @resources = split(/:/,$env{'form.navmaps'});
          } else {
              @resources = ("$env{'form.navmaps'}");
          }
      } else {
          &has_discussion(\@resources);
      }
      my $numitems = @resources;
      my $feedurl = '/adm/navmaps';
      if ($env{'form.navurl'}) { $feedurl .= '?'.$env{'form.navurl'}; }
      my %lt = &Apache::lonlocal::texthash(
          'mnpa' => 'Marked "New" posts as read in a total of',
          'robb' => 'resources/bulletin boards.',
          'twnp' => 'There are currently no resources or discussion boards with unread discussion postings.'
      );       
      foreach my $res (@resources) {
          my $ressymb=$res;
	  &Apache::lonenc::check_decrypt(\$ressymb);
          my $lastkey = $ressymb.'_lastread';
          $discinfo{$lastkey} = $env{'form.navtime'};
      }
      my $textline = "<b>$lt{'mnpa'} $numitems $lt{'robb'}</b>";
      if ($numitems > 0) {
          &Apache::lonnet::put('nohist_'.$env{'request.course.id'}.'_discuss',
			     \%discinfo,$env{'user.domain'},$env{'user.name'});
      } else {
          $textline = "<b>$lt{'twnp'}</b>";
      }
      &Apache::loncommon::content_type($r,'text/html');
      $r->send_http_header;
      my $logo=&Apache::loncommon::lonhttpdurl('/adm/lonIcons/lonlogos.gif');
      my %onload;

      my $start_page=
	  &Apache::loncommon::start_page('New posts marked as read',undef,
					 {'redirect'    => [2,$feedurl],
					  'only_body'   => 1,
					  'add_entries' => \%onload});
      my $end_page = &Apache::loncommon::end_page();
      $r->print (<<ENDREDIR);
$start_page
<img align="right" src="$logo" />
$textline
<form name="reldt" action="$feedurl" target="loncapaclient">
</form>
<br />
$end_page
ENDREDIR
      return OK;
  } elsif ($env{'form.modifydisp'}) {
      my ($symb,$feedurl)=&get_feedurl_and_clean_symb($env{'form.modifydisp'});
      my ($dispchgA,$dispchgB,$markchg,$toggchg) = 
	  split(/_/,$env{'form.changes'});
      &print_display_options($r,$symb,$env{'form.previous'},$dispchgA,
			     $dispchgB,$markchg,$toggchg,$feedurl);
      return OK;
  } elsif ($env{'form.markondisp'} || $env{'form.markonread'} ||
	   $env{'form.allposts'}   || $env{'form.onlyunread'} ||
	   $env{'form.onlyunmark'} || $env{'form.toggoff'}    ||
	   $env{'form.toggon'}     || $env{'form.markread'}) {
      my ($symb,$feedurl)=&get_feedurl_and_clean_symb($env{'form.symb'});
      my %discinfo;
# ------------------------ Modify setting for read/unread toggle for each post 
      if ($env{'form.toggoff'}) { $discinfo{$symb.'_readtoggle'}=0; }
      if ($env{'form.toggon'})  { $discinfo{$symb.'_readtoggle'}=1; }
# --------- Modify setting for identification of 'NEW' posts in this discussion
      if ($env{'form.markondisp'}) {
	  $discinfo{$symb.'_lastread'} = time;
	  $discinfo{$symb.'_markondisp'} = 1;
      }
      if ($env{'form.markonread'}) {
	  if ( $env{'form.previous'} > 0 ) {
	      $discinfo{$symb.'_lastread'} = $env{'form.previous'};
	  }
	  $discinfo{$symb.'_markondisp'} = 0;
      }
# --------------------------------- Modify display setting for this discussion 
      if ($env{'form.allposts'}) {
	  $discinfo{$symb.'_showonlyunread'} = 0;
	  $discinfo{$symb.'_showonlyunmark'} = 0;
      }
      if ($env{'form.onlyunread'}) { $discinfo{$symb.'_showonlyunread'} = 1;  }
      if ($env{'form.onlyunmark'}) { $discinfo{$symb.'_showonlyunmark'} = 1;  }
# ----------------------------------------------------- Mark new posts not NEW 
      if ($env{'form.markread'})   { $discinfo{$symb.'_lastread'} = time; }
      &Apache::lonnet::put('nohist_'.$env{'request.course.id'}.'_discuss',
			   \%discinfo,$env{'user.domain'},$env{'user.name'});
      my $previous=$env{'form.previous'};
      if ($env{'form.markondisp'}) { $previous=undef; }
      &redirect_back($r,$feedurl,&mt('Changed display status').'<br />',
		     '0','0','','',$previous,'','','','','','',$group);
      return OK;
  } elsif (($env{'form.hide'}) || ($env{'form.unhide'})) {
# ----------------------------------------------------------------- Hide/unhide
      my $entry=$env{'form.hide'}?$env{'form.hide'}:$env{'form.unhide'};
      my ($symb,$idx)=split(/\:\:\:/,$entry);
      ($symb,my $feedurl)=&get_feedurl_and_clean_symb($symb);

      my $crs='/'.$env{'request.course.id'};
      if ($env{'request.course.sec'}) {
          $crs.='_'.$env{'request.course.sec'};
      }
      $crs=~s/\_/\//g;
      my $seeid=&Apache::lonnet::allowed('rin',$crs);

      if ($env{'form.hide'} && !$seeid && !(&editing_allowed($env{'form.hide'},$env{'form.group'}))) {
          &redirect_back($r,$feedurl,&mt('Deletion not permitted').'<br />',                 '0','0','','',$env{'form.previous'},'','','','',
                 undef,undef,$group,);
          return OK;
      }

      my %contrib=&Apache::lonnet::restore($symb,$env{'request.course.id'},
                          $env{'course.'.$env{'request.course.id'}.'.domain'},
		          $env{'course.'.$env{'request.course.id'}.'.num'});

      my $currenthidden=$contrib{'hidden'};
      my $currentstudenthidden=$contrib{'studenthidden'};

      if ($env{'form.hide'}) {
	  $currenthidden.='.'.$idx.'.';
	  unless ($seeid) {
	      $currentstudenthidden.='.'.$idx.'.';
	  }
      } else {
	  $currenthidden=~s/\.$idx\.//g;
      }
      my %newhash=('hidden' => $currenthidden);
      if ( ($env{'form.hide'}) && (!$seeid) ) {
	  $newhash{'studenthidden'} = $currentstudenthidden;
      }
      if ($env{'form.hide'}) {
          my $changelast = 0;
          my $newlast;
          ($changelast,$newlast) = &get_discussion_info($idx,%contrib);
          if ($changelast) {
              &Apache::lonnet::put('discussiontimes',{$symb => $newlast},
                     $env{'course.'.$env{'request.course.id'}.'.domain'},
                     $env{'course.'.$env{'request.course.id'}.'.num'});
          }
      }
      &Apache::lonnet::store(\%newhash,$symb,$env{'request.course.id'},
                           $env{'course.'.$env{'request.course.id'}.'.domain'},
			   $env{'course.'.$env{'request.course.id'}.'.num'});

      &redirect_back($r,$feedurl,&mt('Changed discussion status').'<br />',
		     '0','0','','',$env{'form.previous'},undef,undef,undef,
                     undef,undef,undef,$group);
      return OK;
  } elsif ($env{'form.cmd'}=~/^(threadedoff|threadedon)$/) {
      my ($symb,$feedurl)=&get_feedurl_and_clean_symb($env{'form.symb'});
      if ($env{'form.cmd'} eq 'threadedon') {
	  &Apache::lonnet::put('environment',{'threadeddiscussion' => 'on'});
	  &Apache::lonnet::appenv({'environment.threadeddiscussion' => 'on'});
      } else {
 	  &Apache::lonnet::del('environment',['threadeddiscussion']);
	  &Apache::lonnet::delenv('environment.threadeddiscussion');
      }
      &redirect_back($r,$feedurl,&mt('Changed discussion view mode').'<br />',
		     '0','0','','',$env{'form.previous'},undef,undef,undef,
                     undef,undef,undef,$group);
      return OK;
  } elsif ($env{'form.deldisc'}) {
# --------------------------------------------------------------- Hide for good
      my ($symb,$idx)=split(/\:\:\:/,$env{'form.deldisc'});
      ($symb,my $feedurl)=&get_feedurl_and_clean_symb($symb);
      #delete post from feed
      my $course_id = $env{'request.course.id'};
      my $entry_id = $env{'form.deldisc'};
      &Apache::lonfeeds::delete_entry($course_id, 'discussion', $entry_id);

      my %contrib=&Apache::lonnet::restore($symb,$env{'request.course.id'},
                          $env{'course.'.$env{'request.course.id'}.'.domain'},
		          $env{'course.'.$env{'request.course.id'}.'.num'});
      my ($changelast,$newlast) = &get_discussion_info($idx,%contrib);
      if ($changelast) {
          &Apache::lonnet::put('discussiontimes',{$symb => $newlast},
                   $env{'course.'.$env{'request.course.id'}.'.domain'},                   $env{'course.'.$env{'request.course.id'}.'.num'});
      }
      my %newhash=('deleted' => $contrib{'deleted'}.".$idx.");
      &Apache::lonnet::store(\%newhash,$symb,$env{'request.course.id'},
			   $env{'course.'.$env{'request.course.id'}.'.domain'},
			   $env{'course.'.$env{'request.course.id'}.'.num'});
      &redirect_back($r,$feedurl,&mt('Changed discussion status').'<br />',
		     '0','0','','',$env{'form.previous'},undef,undef,undef,
                     undef,undef,undef,$group);
      return OK;
  } elsif ($env{'form.preview'}) {
# -------------------------------------------------------- User wants a preview
      &show_preview($r);
      return OK;
  } elsif ($env{'form.attach'}) {
# -------------------------------------------------------- Work on attachments
      &Apache::loncommon::content_type($r,'text/html');
      $r->send_http_header;
      &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},['subject','comment','addnewattach','delnewattach','timestamp','numoldver','idx','discuss','blog']);
      my (@currnewattach,@currdelold,@keepold,$toolarge);
      &process_attachments(\@currnewattach,\@currdelold,\@keepold);
      if (exists($env{'form.addnewattach.filename'})) {
          if (length($env{'form.addnewattach'})<=$attachmax{'num'}) {
              my $subdir = 'feedback/'.$env{'form.timestamp'};
              my $newattachment=&Apache::lonnet::userfileupload('addnewattach',undef,$subdir);
	      push(@currnewattach, $newattachment);
          } else {
              $toolarge = '<p><span class="LC_warning">'.&mt('Attachment not included - exceeded permitted length').'</span><br /></p>';
          }
      }
      my $attachmenturls;
      my ($symb) = &get_feedurl_and_clean_symb($env{'form.attach'});
      my $idx = $env{'form.idx'};
      if ($idx) {
          my %contrib=&Apache::lonnet::restore($symb,$env{'request.course.id'},
                         $env{'course.'.$env{'request.course.id'}.'.domain'},
                         $env{'course.'.$env{'request.course.id'}.'.num'});
          $attachmenturls = $contrib{$idx.':attachmenturl'};
      }
      &modify_attachments($r,\@currnewattach,\@currdelold,$symb,$idx,
			  $attachmenturls,$attachmax{'text'},$toolarge);
      return OK;
  } elsif ($env{'form.export'}) {
      &Apache::loncommon::content_type($r,'text/html');
      $r->send_http_header;
      my ($symb,$feedurl) = &get_feedurl_and_clean_symb($env{'form.export'});
      my $mode='board';
      my $status='OPEN';
      my $previous=$env{'form.previous'};
      if ($feedurl =~ /\.(problem|exam|quiz|assess|survey|form|library|task)$/) {
          $mode='problem';
          $status=$Apache::inputtags::status[-1];
      }
      my $discussion = &list_discussion($mode,$status,$symb); 
      my $start_page = 
	  &Apache::loncommon::start_page('Resource Feedback and Discussion');
      my $end_page = 
	  &Apache::loncommon::end_page();
      $r->print($start_page.$discussion.$end_page);
      return OK;
  } else {
# ------------------------------------------------------------- Normal feedback
      my $feedurl=$env{'form.postdata'};
      $feedurl=~s/^https?\:\/\///;
      $feedurl=~s/^$ENV{'SERVER_NAME'}//;
      $feedurl=~s/^$ENV{'HTTP_HOST'}//;
      $feedurl=~s/\?.+$//;

      my $symb;
      if ($env{'form.replydisc'}) {
	  $symb=(split(/\:\:\:/,$env{'form.replydisc'}))[0];
      } elsif ($env{'form.editdisc'}) {
	  $symb=(split(/\:\:\:/,$env{'form.editdisc'}))[0];
      } elsif ($env{'form.origpage'}) {
	  $symb=""; 
      } else {
	  $symb=&Apache::lonnet::symbread($feedurl);
      }
      unless ($symb) {
	  $symb=$env{'form.symb'};
      }
      if (defined($symb)) {
          ($symb,$feedurl)=&get_feedurl_and_clean_symb($symb);
      } else {
          # backward compatibility (bulletin boards used to be 'wrapped')
          &Apache::lonenc::check_decrypt(\$feedurl);
          &dewrapper(\$feedurl);
      }
      my $goahead=1;
      if ($feedurl=~/\.(problem|exam|quiz|assess|survey|form|task)$/) {
	  unless ($symb) { $goahead=0; }
      }
      if (!$goahead) {
          # Ambiguous Problem Resource
	  $r->internal_redirect('/adm/ambiguous');
	  return OK;
      }
# Go ahead with feedback, no ambiguous reference
      unless (
	  (
	   ($feedurl=~m:^/res:) && ($feedurl!~m:^/res/adm:)
	   ) 
	  || 
	  ($env{'request.course.id'} && ($feedurl!~m:^/adm:))
	  ||
	  ($env{'request.course.id'} && ($symb=~/^bulletin\_\_\_/))
	  ) {
	  &Apache::loncommon::content_type($r,'text/html');
	  $r->send_http_header;
# Unable to give feedback
          &Apache::lonenc::check_encrypt(\$feedurl);
	  &no_redirect_back($r,$feedurl);
	  return OK;
      }
# --------------------------------------------------- Print login screen header
      unless ($env{'form.sendit'}) {
          &Apache::lonenc::check_encrypt(\$feedurl);
	  &Apache::loncommon::content_type($r,'text/html');
	  $r->send_http_header;
          if (($env{'form.replydisc'}) || ($env{'form.editdisc'})) {
              my ($blocked,$blocktext) = 
                     &Apache::loncommon::blocking_status('boards');
              if ($blocked) {
                  $r->print(&blocked_reply_or_edit($blocktext));
                  return OK;
              }
          }
	  my $options=&screen_header($feedurl,$symb,$group);
	  if ($options) {
	      &mail_screen($r,$feedurl,$options,$symb,$attachmax{'text'});
	  } else {
	      &fail_redirect($r,$feedurl);
	  }
	  return OK;
      }
      
# Get previous user input
      my $prevattempts=&Apache::loncommon::get_previous_attempt(
                                   $symb,$env{'user.name'},$env{'user.domain'},
				   $env{'request.course.id'});

# Get output from resource
      &Apache::lonenc::check_encrypt(\$feedurl);
      my $usersaw=&resource_output($feedurl);

# Get resource answer (need to allow student to view grades for this to work)
      &Apache::lonnet::appenv({'allowed.vgr'=>'F'});
      my $usersymb = &Apache::lonenc::check_encrypt($symb);
      my $useranswer=
          &Apache::loncommon::get_student_answers(
              $usersymb,$env{'user.name'},$env{'user.domain'},
              $env{'request.course.id'});
      &Apache::lonnet::delenv('allowed.vgr');
# Get attachments, if any, and not too large
      my $attachmenturl='';
      my $toolarge='';
      if (($env{'form.origpage'}) || ($env{'form.editdisc'}) ||
	  ($env{'form.replydisc'})) {
	  my ($symb,$idx);
	  if ($env{'form.replydisc'}) {
	      ($symb,$idx)=split(/\:\:\:/,$env{'form.replydisc'});
	  } elsif ($env{'form.editdisc'}) {
	      ($symb,$idx)=split(/\:\:\:/,$env{'form.editdisc'});
	  } elsif ($env{'form.origpage'}) {
	      $symb = $env{'form.symb'};
	  }
	  &Apache::lonenc::check_decrypt(\$symb);
	  my @currnewattach = ();
	  my @deloldattach = ();
	  my @keepold = ();
	  &process_attachments(\@currnewattach,\@deloldattach,\@keepold);
	  $symb=~s|(bulletin___\d+___)adm/wrapper/|$1|;
	  $attachmenturl=&construct_attachmenturl(\@currnewattach,\@keepold,$symb,$idx);
      } elsif ($env{'form.attachment.filename'}) {
	  if (length($env{'form.attachment'})<=$attachmax{'num'}) {
              my $now = time;
              my $subdir = 'feedback/'.$now;
	      $attachmenturl=&Apache::lonnet::userfileupload('attachment',undef,$subdir);
	  } else {
              $toolarge = '<p><span class="LC_warning">'.&mt('Attachment not included - exceeded permitted length').'</span><br /></p>';
          }
      }
# Filter HTML out of message (could be nasty)
      my $override;
      if ($env{'form.discuss'} =~ /^(?:author|question|course|policy)$/) {
          $override = 1;
      }
      my $message=&clear_out_html($env{'form.comment'},$override);

# Assemble email
      my ($email,$citations)=&assemble_email($message,$prevattempts,
					     $usersaw,$useranswer);
 
# Who gets this?
      my ($typestyle,%to) = &Apache::lonmsg::decide_receiver($feedurl);

# Actually send mail
      my ($status,$numsent)=&send_msg(&clear_out_html($env{'form.subject'}),
				      $feedurl,$email,$citations,
				      $attachmenturl,$usersymb,%to);

# Discussion? Store that.
      my $numpost=0;
      if (  ($env{'form.discuss'} ne ''
	     && $env{'form.discuss'} !~ /^(?:author|question|course|policy)/)
	   || $env{'form.anondiscuss'} ne '') {
	  my $subject = &clear_out_html($env{'form.subject'});
	  my $anonmode=($env{'form.discuss'} eq 'anon' || $env{'form.anondiscuss'} );
	  $typestyle.=&adddiscuss($symb,$message,$anonmode,$attachmenturl,
				  $subject,$group);
	  $numpost++;
      }

# Add to blog?

      my $blog='';
      if ($env{'form.blog'}) {
	  my $subject = &clear_out_html($env{'form.subject'});
	  $status.=&Apache::lonrss::addentry($env{'user.name'},
				    $env{'user.domain'},
				    'CourseBlog_'.$env{'request.course.id'},
				    $subject,$message,$feedurl,'public');
          if (&Apache::loncommon::course_type() eq 'Community') {
              $blog='<br />'.&mt('Added to my community blog').'<br />';
          } else {
	      $blog='<br />'.&mt('Added to my course blog').'<br />';
          }
      }
	  
# Receipt screen and redirect back to where came from
      &redirect_back($r,$feedurl,$typestyle,$numsent,$numpost,$blog,$status,$env{'form.previous'},undef,undef,undef,undef,undef,undef,$group,$toolarge);
  }
  return OK;
}

sub blocked_reply_or_edit {
    my ($blocktext) = @_;
    return 
      &Apache::loncommon::start_page('Resource Feedback and Discussion').
      $blocktext.'<br /><br /><a href="javascript:history.go(-1)">'.
      &mt('Back to previous page').
      &Apache::loncommon::end_page();
} 

sub wrap_symb {
    my ($ressymb)=@_;
    if ($ressymb =~ /bulletin___\d+___/) {
        unless ($ressymb =~ m|bulletin___\d+___adm/wrapper|) {
            $ressymb=~s|(bulletin___\d+___)|$1adm/wrapper|;
        }
    }
    return $ressymb;
}
sub dewrapper {
    my ($feedurl)=@_;
    if ($$feedurl=~m|^/adm/wrapper/adm/.*/bulletinboard$|) {
        $$feedurl=~s|^/adm/wrapper||;
    }
}

sub get_feedurl {
    my ($symb)=@_;
    my ($map,$ind,$url)=&Apache::lonnet::decode_symb($symb);
    my $feedurl = &Apache::lonnet::clutter($url);
    &dewrapper(\$feedurl);
    return $feedurl;
}

sub get_feedurl_and_clean_symb {
    my ($symb)=@_;
    &Apache::lonenc::check_decrypt(\$symb);
# backward compatibility (bulletin boards used to be 'wrapped')
    unless ($symb =~ m|bulletin___\d+___adm/wrapper|) {
	$symb=~s|(bulletin___\d+___)|$1adm/wrapper|;
    }
    my $feedurl = &get_feedurl($symb);
    return ($symb,$feedurl);
}

sub editing_allowed {
    my ($postid,$group) = @_;
    $postid = &unescape($postid);
    my $can_edit = 0;
    if ($group ne '') {
        my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
        my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
        if ($postid =~ m|^bulletin___\d+___adm/wrapper(/adm/\Q$cdom\E/\Q$cnum\E/\d+/bulletinboard)|) {
            if (&check_group_priv($group,'egp') eq 'ok') {
                $can_edit = 1;
            }
            return $can_edit;
        }     
    } 
    my $cid = $env{'request.course.id'};
    my $role = (split(/\./,$env{'request.role'}))[0];
    my $section = $env{'request.course.sec'};
    my $allow_editing_config = 
	$env{'course.'.$cid.'.allow_discussion_post_editing'};
    if ($allow_editing_config =~ m/^\s*yes\s*$/i) {
        $can_edit = 1;
    } else {
	foreach my $editor (split(/,/,$allow_editing_config)) {
	    my ($editor_role,$editor_sec) = split(/:/,$editor);
	    if ($editor_role eq $role
		&& defined($editor_sec)
		&& defined($section)
		&& $editor_sec eq $section) {
		$can_edit = 1;
		last;
	    }
	    if ($editor_role eq $role
		&& !defined($editor_sec)) {
		$can_edit = 1;
	    }
	}
    }
    return $can_edit;
}

sub check_group_priv {
    my ($group,$grp_priv) = @_;
    foreach my $priv ('mdg','vcg') {
        my $checkcourse = $env{'request.course.id'}.
            ($env{'request.course.sec'}?'/'.$env{'request.course.sec'}:'');
        if (&Apache::lonnet::allowed($priv,$checkcourse)) {
            return 'ok';
        }
    }
    if ($grp_priv && $group ne '') {
        if (&Apache::lonnet::allowed($grp_priv,$env{'request.course.id'}.'/'.$group)) {
            return 'ok';
        }
    }
    return '';
}

sub group_args { 
    my ($group) = @_;
    if ($group eq '') { return ''; }
    my $extra_args = '&amp;group='.$group;
    if (exists($env{'form.ref'})) {
        $extra_args .= '&amp;ref='.$env{'form.ref'};
    }
    return $extra_args;
}

sub get_resource_title {
    my ($symb,$feedurl) = @_;
    my ($restitle,$plainurl);
    if (defined($symb)) {
        my $plain_symb = &Apache::lonenc::check_decrypt($symb);
        $restitle = &Apache::lonnet::gettitle($plain_symb);
    }
    if (defined($feedurl)) {
        $plainurl = &Apache::lonenc::check_decrypt($feedurl);
    }
    if (!defined($restitle)) {
        if (defined($feedurl)) {
            $restitle = &Apache::lonnet::gettitle($plainurl);
        }
    }
    if ($plainurl ne $feedurl) {
        my ($plain_filename) = ($plainurl =~ m-/([^/]+)$-);
        if ($plain_filename eq $restitle) {
            $restitle = &mt('Untitled resource');
        }
    }
    if ($restitle eq '') {
        $restitle = &mt('Untitled resource');
    }
    return $restitle;
}

1;
__END__


=pod

=head1 NAME

Apache::lonfeedback.pm

=head1 SYNOPSIS

Handles feedback from students to instructors and system administrators.

Provides a screenshot of the current resource, as well as previous attempts if the resource was a homework.

Used by lonmsg.pm.

This is part of the LearningOnline Network with CAPA project
described at http://www.lon-capa.org.

=head1 OVERVIEW

None

=head1 SUBROUTINES

=over

=item discussion_open()

=item discussion_visible()

=item list_discussion()

=item send_feedback_link()

=item send_message_link()

=item action_links_bar()

=item postingform_display()

=item build_posting_display

=item filter_regexp()

=item get_post_contents()

=item replicate_attachments()

=item mail_screen()

=item print_display_options()

=item print_sortfilter_options()

=item print_showposters()

=item get_post_versions()

=item get_post_attachments()

=item fail_redirect()

=item redirect_back()

=item no_redirect_back()

=item screen_header()

=item resource_output()

=item clear_out_html()

=item assemble_email()

=item feedback_available()

=item send_msg()

=item adddiscuss()

=item get_discussion_info()

=item show_preview()

=item newline_to_br()

=item tidy_html()

=item generate_preview_button()

=item modify_attachments()

=item process_attachments()

=item generate_attachments_button()

=item extract_attachments()

=item construct_attachmenturl()

=item add_blog_checkbox()

=item has_discussion()

=item sort_filter_names()

=item handler()

=item blocked_reply_or_edit()

=item wrap_symb()

=item dewrapper()

=item get_feedurl()

=item get_feedurl_and_clean_symb()

=item editing_allowed()

=item check_group_priv()

=item group_args()

=item get_resource_title()

=back

=cut

Index: modules/ehlerst/homescreen/lonfeeds.pm
+++ modules/ehlerst/homescreen/lonfeeds.pm
# The LearningOnline Network with CAPA
# User Roles Screen
#
# $Id: lonfeeds.pm,v 1.1 2011/03/19 15:47:12 ehlerst Exp $
#
# Copyright Michigan State University Board of Trustees
#
# This file is part of the LearningOnline Network with CAPA (LON-CAPA).
#
# LON-CAPA is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# LON-CAPA is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with LON-CAPA; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
#
# /home/httpd/html/adm/gpl.txt
#
# http://www.lon-capa.org/
#
###


package Apache::lonfeeds;

use strict;
use Apache::Constants qw(:common :http);
use Apache::lonnet;
use XML::Feed;
use DateTime;
use FileHandle;


#handler for http access on .atom files
#checkes wether any role of the current user is allowed to read the feed
#returns a user specific feed
sub handler {
  my $r = shift;
  my $uri = $r->uri;
  my ($course_id, $type) = $uri =~ /\/.*\/(.*)-(.*).atom/;
  my $allowed = 0;
  foreach my $key (%env) {
    if ($key =~ /^user\.role\./) {
      my (undef, undef, $role, $course) = split(/\./, $key);
      $role .= '.'.$course;
      $allowed = &is_allowed($course_id, $role, $type);
      last if ($allowed);
    }
  }
  if ($allowed) {
    my $feed = &get_feed_for_user($course_id, $type);
    if ($feed) {
      $r->content_type("application/xml");
      $r->print($feed->as_xml);
      return OK;
    } else {
      return HTTP_NOT_FOUND;
    }
  }
  return HTTP_NOT_ACCEPTABLE;
}

#checkes wether the passed role is allowed to read a specific feed
sub is_allowed {
  my ($course_id, $role, $type) = @_;
  my $allowed = 0;
  my $req_priv;
  my $fh = FileHandle->new('< /home/httpd/lonTabs/feeds.rights');
  if (defined $fh) {
    while(<$fh>) {
      if (/\Q$type\E:(\w+)/) {
        $req_priv = $1;
      }
    }
    undef $fh;
  } else {
    return $allowed;
  }
  if (!$req_priv) {
    return $allowed;
  }
  my $rolecache = $env{'request.role'};
  $env{'request.role'} = $role;
  $allowed = &Apache::lonnet::allowed($req_priv,$course_id);
  $env{'request.role'} = $rolecache;
  return $allowed;
}

sub create_feed {
  my ($course_id, $type, $course_title) = @_;
  my $feed = XML::Feed->new('Atom');
  $feed->title($course_title);
  $feed->id($course_id);
  $feed->tagline($type);
  return $feed;
}


#creates a new entry in a spcific feed
#creates a new feed, if it doesn't already exist
#$updated should be a DateTime object
sub new_entry {
  my ($course_id, $type, $course_title, $id, $title, $link, $author, $updated, $category, $content) = @_;
  my $feed = &get_feed($course_id, $type);
  if (!defined $feed) {
    $feed = &create_feed($course_id, $type, $course_title);
  }
  my $entry = XML::Feed::Entry->new();
  $entry->id($id);
  $entry->title($title);
  $entry->link($link);
  $entry->author($author);
  $entry->modified($updated);
  if ($category) {
    $entry->category($category);
  }
  if ($content) {
    $entry->content($content);
  }
  $feed->add_entry($entry);
  my $success = &save_feed($course_id, $type, $feed);
  return $success;
}

#changes the value of all elements, for which a value is passed
sub change_entry {
  my ($course_id, $type, $id, $title, $link, $author, $updated, $category, $content) = @_;
  my $success = 0;
  my $feed = &get_feed($course_id, $type);
  if (!defined $feed) {
    return $success;
  }
  my @entries = $feed->entries;
  my $newfeed = &create_feed($course_id, $type, $feed->title);
  foreach my $entry (@entries) {
    if ($entry->id() eq $id) {
      if($title) {$entry->title($title);}
      if($link) {$entry->link($link);}
      if($author) {$entry->author($author);}
      if($content) {$entry->content($content);}
      if($updated) {$entry->modified($updated);}
      if($category) {$entry->category($category);}
    }
   $newfeed->add_entry($entry);
  }
  $success = &save_feed($course_id, $type, $newfeed);
  return $success;
}

#deletes a single entry defined by $id
sub delete_entry {
  my($course_id, $type, $id) = @_;
  my $success = 0;
  my $feed = &get_feed($course_id, $type);
  if (!defined $feed) {
    return $success;
  }
  my @entries = $feed->entries;
  my $newfeed = &create_feed($course_id, $type, $feed->title);
  foreach my $entry (@entries) {
    if ($entry->id ne $id) {
      $newfeed->add_entry($entry);
    }
  }
  $success = &save_feed($course_id, $type, $newfeed);
  return $success;
}

# $id can be either an array of feed-ids or the category of a group of entries
sub delete_entries {
  my ($course_id, $type, $id) = @_;
  my $feed = &get_feed($course_id, $type);
  my $success = 0;
  if (!defined $feed) {
    return $success;
  }
  my @entries = $feed->entries;
  my $newfeed = &create_feed($course_id, $type, $feed->title);
  if (ref($id) eq 'ARRAY') {
    foreach my $entry (@entries) {
      foreach my $value (@{$id}) {
        if ($entry->id ne $value) {
          $newfeed->add_entry($entry);
        }
      }
    }
  } elsif (!ref($id)) {
    foreach my $entry (@entries) {
      if ($entry->category ne $id) {
        $newfeed->add_entry($entry);
      }
    }
  } else {
    return $success;
  }
  $success = &save_feed($course_id, $type, $newfeed);
  return $success;
}

#reads a feed specified by $course_id and $type abd returns a XML::Feed Object
sub get_feed {
  my ($course_id, $type) = @_;
  my $path = '/home/httpd/html/adm/lonFeeds/';
  my $filename = $course_id.'-'.$type.'.atom';
  my $feed = undef;
  my $fh = FileHandle->new($path.$filename);
  if (defined $fh) {
    $feed = XML::Feed->parse($fh);
    undef $fh;
  }
  return $feed;
}


#modifies the feeds of a certain type according to the user settings
sub get_feed_for_user {
  my ($course_id, $type) = @_;
  my $feed = &get_feed($course_id, $type);
  if (!defined $feed) {
    return 0;
  }
  my @entries = $feed->entries;
  my $newfeed = &create_feed($course_id, $type, $feed->title);
  
#filter for a specific user
  my $udom = $env{'user.domain'};
  my $uname = $env{'user.name'};

  if ($type eq 'discussion') {
    foreach my $entry (@entries) {
      my $symb = $entry->category;
      my $readkey = $symb.'_lastread';
      my %readinghash = &Apache::lonnet::get('nohist_'.$course_id.'_discuss',[$readkey],$udom,$uname);
      my $lastread;
      foreach my $key (%readinghash) {
        if ($readinghash{$key}) {
          $lastread = $readinghash{$key};
        }      
      }
      if ($lastread) {
        if ($lastread < $entry->modified->epoch()) {
          $newfeed->add_entry($entry);
        }
      } else {
        $newfeed->add_entry($entry);
      }
    } 
  } else {
      return $feed;
  }
  return $newfeed; 
}

sub gather_feeds {
  my ($course_id, $role, $feed_types, $feeds) = @_;
  foreach my $type (@{$feed_types}) {
    if (!$$feeds{$type}) {
      if (&is_allowed($course_id, $role, $type)) {
        my $feed = &get_feed_for_user($course_id, $type);
        $$feeds{$type} = $feed;
      } else {
        $$feeds{$type} = '';
      }
    }
  }
}

#saves the feed to a default directory
sub save_feed {
  my ($course_id, $type, $feed) = @_;
  my $path = '/home/httpd/html/adm/lonFeeds/';
  my $filename = $course_id.'-'.$type.'.atom';
  my $file = $path.$filename;
  my $fh = FileHandle->new("> $file");
  if (defined $fh) {
    my $content = $feed->as_xml;
    print $fh $content;
    undef $fh;
  } else {
    return 0;
  }
  return 1;
}

1;

Index: modules/ehlerst/homescreen/lonroles.pm
+++ modules/ehlerst/homescreen/lonroles.pm
# The LearningOnline Network with CAPA
# User Roles Screen
#
# $Id: lonroles.pm,v 1.1 2011/03/19 15:47:12 ehlerst Exp $
#
# Copyright Michigan State University Board of Trustees
#
# This file is part of the LearningOnline Network with CAPA (LON-CAPA).
#
# LON-CAPA is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# LON-CAPA is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with LON-CAPA; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
#
# /home/httpd/html/adm/gpl.txt
#
# http://www.lon-capa.org/
#
###

=pod

=head1 NAME

Apache::lonroles - User Roles Screen

=head1 SYNOPSIS

Invoked by /etc/httpd/conf/srm.conf:

 <Location /adm/roles>
 PerlAccessHandler       Apache::lonacc
 SetHandler perl-script
 PerlHandler Apache::lonroles
 ErrorDocument     403 /adm/login
 ErrorDocument	  500 /adm/errorhandler
 </Location>

=head1 OVERVIEW

=head2 Choosing Roles

C<lonroles> is a handler that allows a user to switch roles in
mid-session. LON-CAPA attempts to work with "No Role Specified", the
default role that a user has before selecting a role, as widely as
possible, but certain handlers for example need specification which
course they should act on, etc. Both in this scenario, and when the
handler determines via C<lonnet>'s C<&allowed> function that a certain
action is not allowed, C<lonroles> is used as error handler. This
allows the user to select another role which may have permission to do
what they were trying to do.

=begin latex

\begin{figure}
\begin{center}
\includegraphics[width=0.45\paperwidth,keepaspectratio]{Sample_Roles_Screen}
  \caption{\label{Sample_Roles_Screen}Sample Roles Screen} 
\end{center}
\end{figure}

=end latex

=head2 Role Initialization

The privileges for a user are established at login time and stored in the session environment. As a consequence, a new role does not become active till the next login. Handlers are able to query for privileges using C<lonnet>'s C<&allowed> function. When a user first logs in, their role is the "common" role, which means that they have the sum of all of their privileges. During a session it might become necessary to choose a particular role, which as a consequence also limits the user to only the privileges in that particular role.

=head1 INTRODUCTION

This module enables a user to select what role he wishes to
operate under (instructor, student, teaching assistant, course
coordinator, etc).  These roles are pre-established by the actions
of upper-level users.

This is part of the LearningOnline Network with CAPA project
described at http://www.lon-capa.org.

=head1 HANDLER SUBROUTINE

This routine is called by Apache and mod_perl.

=over 4

=item *

Roles Initialization (yes/no)

=item *

Get Error Message from Environment

=item *

Who is this?

=item *

Generate Page Output

=item *

Choice or no choice

=item *

Table

=item *

Privileges

=back

=cut


package Apache::lonroles;

use strict;
use Apache::lonnet;
use Apache::lonuserstate();
use Apache::Constants qw(:common);
use Apache::File();
use Apache::lonmenu;
use Apache::loncommon;
use Apache::lonhtmlcommon;
use Apache::lonannounce;
use Apache::lonlocal;
use Apache::lonpageflip();
use Apache::lonnavdisplay();
use Apache::loncoursequeueadmin;
use Apache::lonfeeds;
use GDBM_File;
use LONCAPA qw(:DEFAULT :match);
use HTML::Entities;

sub redirect_user {
    my ($r,$title,$url,$msg) = @_;
    $msg = $title if (! defined($msg));
    &Apache::loncommon::content_type($r,'text/html');
    &Apache::loncommon::no_cache($r);
    $r->send_http_header;

    # Breadcrumbs
    my $brcrum = [{'href' => $url,
                   'text' => 'Switching Role'},];
    my $start_page = &Apache::loncommon::start_page('Switching Role',undef,
                                                    {'redirect' => [1,$url],
                                                     'bread_crumbs' => $brcrum,});
    my $end_page   = &Apache::loncommon::end_page();

# Note to style police: 
# This must only replace the spaces, nothing else, or it bombs elsewhere.
    $url=~s/ /\%20/g;
    $r->print(<<ENDREDIR);
$start_page
<p>$msg</p>
$end_page
ENDREDIR
    return;
}

sub error_page {
    my ($r,$error,$dest)=@_;
    &Apache::loncommon::content_type($r,'text/html');
    &Apache::loncommon::no_cache($r);
    $r->send_http_header;
    return OK if $r->header_only;
    # Breadcrumbs
    my $brcrum = [{'href' => $dest,
                   'text' => 'Problems during Course Initialization'},];
    $r->print(&Apache::loncommon::start_page('Problems during Course Initialization',
                                             undef,
                                             {'bread_crumbs' => $brcrum,})
    );
    $r->print(
        '<script type="text/javascript">'.
        '// <![CDATA['.
        &Apache::lonmenu::rawconfig().
        '// ]]>'.
        '</script>'.
	      '<p class="LC_error">'.&mt('The following problems occurred:').
          '<br />'.
	      $error.
	      '</p><br /><a href="'.$dest.'">'.&mt('Continue').'</a>'
    );
    $r->print(&Apache::loncommon::end_page());
}

sub handler {

    my $r = shift;

    my $now=time;
    my $then=$env{'user.login.time'};
    my $refresh=$env{'user.refresh.time'};
    if (!$refresh) {
        $refresh = $then;
    }
    my $envkey;
    my %dcroles = ();
    my $numdc = &check_fordc(\%dcroles,$then);
    &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'});
    my $loncaparev = $Apache::lonnet::perlvar{'lonVersion'};

# ================================================================== Roles Init
    if ($env{'form.selectrole'}) {

        my $locknum=&Apache::lonnet::get_locks();
        if ($locknum) { return 409; }

        if ($env{'form.newrole'}) {
            $env{'form.'.$env{'form.newrole'}}=1;
	}
	if ($env{'request.course.id'}) {
            # Check if user is CC trying to select a course role
            if ($env{'form.switchrole'}) {
                my $switch_is_active;
                if (defined($env{'user.role.'.$env{'form.switchrole'}})) {
                    my ($start,$end) = split(/\./,$env{'user.role.'.$env{'form.switchrole'}});
                    if (!$end || $end > $now) {
                        if (!$start || $start < $refresh) {
                            $switch_is_active = 1;
                        }
                    }
                }
                unless ($switch_is_active) {
                    &adhoc_course_role($refresh,$then);
                }
            }
	    my %temp=('logout_'.$env{'request.course.id'} => time);
	    &Apache::lonnet::put('email_status',\%temp);
	    &Apache::lonnet::delenv('user.state.'.$env{'request.course.id'});
	}
	&Apache::lonnet::appenv({"request.course.id"   => '',
			 	 "request.course.fn"   => '',
				 "request.course.uri"  => '',
				 "request.course.sec"  => '',
				 "request.role"        => 'cm',
                                 "request.role.adv"    => $env{'user.adv'},
				 "request.role.domain" => $env{'user.domain'}});
# Check if user is a DC trying to enter a course or author space and needs privs to be created
        if ($numdc > 0) {
            foreach my $envkey (keys %env) {
# Is this an ad-hoc Coordinator role?
                if (my ($ccrole,$domain,$coursenum) =
		    ($envkey =~ m-^form\.(cc|co)\./($match_domain)/($match_courseid)$-)) {
                    if ($dcroles{$domain}) {
                        &Apache::lonnet::check_adhoc_privs($domain,$coursenum,
                                                           $then,$refresh,$now,$ccrole);
                    }
                    last;
                }
# Is this an ad-hoc CA-role?
                if (my ($domain,$user) =
		    ($envkey =~ m-^form\.ca\./($match_domain)/($match_username)$-)) {
                    if (($domain eq $env{'user.domain'}) && ($user eq $env{'user.name'})) {
                        delete($env{$envkey});
                        $env{'form.au./'.$domain.'/'} = 1;
                        my ($server_status,$home) = &check_author_homeserver($user,$domain);
                        if ($server_status eq 'switchserver') {
                            my $trolecode = 'au./'.$domain.'/';
                            my $switchserver = '/adm/switchserver?otherserver='.$home.'&amp;role='.$trolecode;
                            $r->internal_redirect($switchserver);
                        }
                        last;
                    }
                    if (my ($castart,$caend) = ($env{'user.role.ca./'.$domain.'/'.$user} =~ /^(\d*)\.(\d*)$/)) {
                        if (((($castart) && ($castart < $now)) || !$castart) && 
                            ((!$caend) || (($caend) && ($caend > $now)))) {
                            my ($server_status,$home) = &check_author_homeserver($user,$domain);
                            if ($server_status eq 'switchserver') {
                                my $trolecode = 'ca./'.$domain.'/'.$user;
                                my $switchserver = '/adm/switchserver?otherserver='.$home.'&amp;role='.$trolecode;
                                $r->internal_redirect($switchserver);
                            }
                            last;
                        }
                    }
                    # Check if author blocked ca-access
                    my %blocked=&Apache::lonnet::get('environment',['domcoord.author'],$domain,$user);
                    if ($blocked{'domcoord.author'} eq 'blocked') {
                        delete($env{$envkey});
                        $env{'user.error.msg'}=':::1:User '.$user.' in domain '.$domain.' blocked domain coordinator access';
                        last;
                    }
                    if ($dcroles{$domain}) {
                        my ($server_status,$home) = &check_author_homeserver($user,$domain);
                        if (($server_status eq 'ok') || ($server_status eq 'switchserver')) {
                            &Apache::lonnet::check_adhoc_privs($domain,$user,$then,
                                                               $refresh,$now,'ca');
                            if ($server_status eq 'switchserver') {
                                my $trolecode = 'ca./'.$domain.'/'.$user; 
                                my $switchserver = '/adm/switchserver?'
                                                  .'otherserver='.$home.'&amp;role='.$trolecode;
                                $r->internal_redirect($switchserver);
                            }
                        } else {
                            delete($env{$envkey});
                        }
                    } else {
                        delete($env{$envkey});
                    }
                    last;
                }
            }
        }

        foreach $envkey (keys %env) {
            next if ($envkey!~/^user\.role\./);
            my ($where,$trolecode,$role,$tstatus,$tend,$tstart);
            &Apache::lonnet::role_status($envkey,$then,$refresh,$now,\$role,\$where,
                                         \$trolecode,\$tstatus,\$tstart,\$tend);
            if ($env{'form.'.$trolecode}) {
		if ($tstatus eq 'is') {
		    $where=~s/^\///;
		    my ($cdom,$cnum,$csec)=split(/\//,$where);
                    if (($cnum) && ($role ne 'ca') && ($role ne 'aa')) {
                        my $home = $env{'course.'.$cdom.'_'.$cnum.'.home'};
                        my @ids = &Apache::lonnet::current_machine_ids();
                        unless ($loncaparev eq '' && $home && grep(/^\Q$home\E$/,@ids)) {
                            my %curr_reqd_hash = &Apache::lonnet::userenvironment($cdom,$cnum,'internal.releaserequired');
                            if ($curr_reqd_hash{'internal.releaserequired'} ne '') {
                                my ($switchserver,$switchwarning) =
                                    &check_release_required($loncaparev,$cdom.'_'.$cnum,$trolecode,$curr_reqd_hash{'internal.releaserequired'});
                                if ($switchwarning ne '' || $switchserver ne '') {
                                    &Apache::loncommon::content_type($r,'text/html');
                                    &Apache::loncommon::no_cache($r);
                                    $r->send_http_header;
                                    my $end_page=&Apache::loncommon::end_page();
                                    $r->print(&Apache::loncommon::start_page('Selected course unavailable on this server').
                                              '<p class="LC_warning">');
                                    if ($switchwarning) {
                                        $r->print($switchwarning.'<br /><a href="/adm/roles">');
                                        if (&Apache::loncommon::show_course()) {
                                            $r->print(&mt('Display courses'));
                                        } else {
                                            $r->print(&mt('Display roles'));
                                        }
                                        $r->print('</a>');
                                    } elsif ($switchserver) {
				        $r->print(&mt('This course requires a newer version of LON-CAPA than is installed on this server.').
                                                  '<br />'.
                                                  '<a href="/adm/switchserver?'.$switchserver.'">'.
                                                  &mt('Switch Server').
                                                  '</a>');
                                    }
                                    $r->print('</p>'.&Apache::loncommon::end_page());
                                    return OK;
                                }
                            }
                        }
                    }
# check for course groups
                    my %coursegroups = &Apache::lonnet::get_active_groups(
                          $env{'user.domain'},$env{'user.name'},$cdom, $cnum);
                    my $cgrps = join(':',keys(%coursegroups));

# store role if recent_role list being kept
                    if ($env{'environment.recentroles'}) {
                        my %frozen_roles =
                           &Apache::lonhtmlcommon::get_recent_frozen('roles',$env{'environment.recentrolesn'});
			&Apache::lonhtmlcommon::store_recent('roles',
							     $trolecode,' ',$frozen_roles{$trolecode});
                    }


# check for keyed access
		    if (($role eq 'st') && 
                       ($env{'course.'.$cdom.'_'.$cnum.'.keyaccess'} eq 'yes')) {
# who is key authority?
			my $authdom=$cdom;
			my $authnum=$cnum;
			if ($env{'course.'.$cdom.'_'.$cnum.'.keyauth'}) {
			    ($authnum,$authdom)=
				split(/:/,$env{'course.'.$cdom.'_'.$cnum.'.keyauth'});
			}
# check with key authority
			unless (&Apache::lonnet::validate_access_key(
				     $env{'environment.key.'.$cdom.'_'.$cnum},
					     $authdom,$authnum)) {
# there is no valid key
			     if ($env{'form.newkey'}) {
# student attempts to register a new key
				 &Apache::loncommon::content_type($r,'text/html');
				 &Apache::loncommon::no_cache($r);
				 $r->send_http_header;
				 my $swinfo=&Apache::lonmenu::rawconfig();
				 my $start_page=&Apache::loncommon::start_page
				    ('Verifying Access Key to Unlock this Course');
				 my $end_page=&Apache::loncommon::end_page();
				 my $buttontext=&mt('Enter Course');
				 my $message=&mt('Successfully registered key');
				 my $assignresult=
				     &Apache::lonnet::assign_access_key(
						     $env{'form.newkey'},
						     $authdom,$authnum,
						     $cdom,$cnum,
                                                     $env{'user.domain'},
						     $env{'user.name'},
                                                     &mt('Assigned from [_1] at [_2] for [_3]'
                                                        ,$ENV{'REMOTE_ADDR'}
                                                        ,&Apache::lonlocal::locallocaltime()
                                                        ,$trolecode)
                                                     );
				 unless ($assignresult eq 'ok') {
				     $assignresult=~s/^error\:\s*//;
				     $message=&mt($assignresult).
				     '<br /><a href="/adm/logout">'.
				     &mt('Logout').'</a>';
				     $buttontext=&mt('Re-Enter Key');
				 }
				 $r->print(<<ENDENTEREDKEY);
$start_page
<script type="text/javascript">
// <![CDATA[
$swinfo
// ]]>
</script>
<form action="" method="post">
<input type="hidden" name="selectrole" value="1" />
<input type="hidden" name="$trolecode" value="1" />
<span class="LC_fontsize_large">$message</span><br />
<input type="submit" value="$buttontext" />
</form>
$end_page
ENDENTEREDKEY
                                 return OK;
			     } else {
# print form to enter a new key
				 &Apache::loncommon::content_type($r,'text/html');
				 &Apache::loncommon::no_cache($r);
				 $r->send_http_header;
				 my $swinfo=&Apache::lonmenu::rawconfig();
				 my $start_page=&Apache::loncommon::start_page
				    ('Enter Access Key to Unlock this Course');
				 my $end_page=&Apache::loncommon::end_page();
				 $r->print(<<ENDENTERKEY);
$start_page
<script type="text/javascript">
// <![CDATA[
$swinfo
// ]]>
</script>
<form action="" method="post">
<input type="hidden" name="selectrole" value="1" />
<input type="hidden" name="$trolecode" value="1" />
<input type="text" size="20" name="newkey" value="$env{'form.newkey'}" />
<input type="submit" value="Enter key" />
</form>
$end_page
ENDENTERKEY
				 return OK;
			     }
			 }
		     }
		    &Apache::lonnet::log($env{'user.domain'},
					 $env{'user.name'},
					 $env{'user.home'},
					 "Role ".$trolecode);
		    
		    &Apache::lonnet::appenv(
					   {'request.role'        => $trolecode,
					    'request.role.domain' => $cdom,
					    'request.course.sec'  => $csec,
                                            'request.course.groups' => $cgrps});
                    my $tadv=0;

		    if (($cnum) && ($role ne 'ca') && ($role ne 'aa')) {
                        my $msg;
			my ($furl,$ferr)=
			    &Apache::lonuserstate::readmap($cdom.'/'.$cnum);
			if (($env{'form.orgurl'}) && 
			    ($env{'form.orgurl'}!~/^\/adm\/flip/)) {
			    my $dest=$env{'form.orgurl'};
                            if ($env{'form.symb'}) {
                                if ($dest =~ /\?/) {
                                    $dest .= '&';
                                } else {
                                    $dest .= '?'
                                }
                                $dest .= 'symb='.$env{'form.symb'};
                            }
			    if (&Apache::lonnet::allowed('adv') eq 'F') { $tadv=1; }
			    &Apache::lonnet::appenv({'request.role.adv'=>$tadv});
                            if (($ferr) && ($tadv)) {
				&error_page($r,$ferr,$dest);
			    } else {
                                if ($dest =~ m{^/adm/coursedocs\?folderpath}) {
                                    if ($env{'request.course.id'} eq $cdom.'_'.$cnum) { 
                                        my $chome = &Apache::lonnet::homeserver($cnum,$cdom);
                                        &update_content_constraints($cdom,$cnum,$chome,$cdom.'_'.$cnum);
                                    }
                                }
				$r->internal_redirect($dest);
			    }
			    return OK;
			} else {
			    if (!$env{'request.course.id'}) {
				&Apache::lonnet::appenv(
				      {"request.course.id"  => $cdom.'_'.$cnum});
				$furl='/adm/roles?tryagain=1';
                $msg='<p><span class="LC_error">'
                    .&mt('Could not initialize [_1] at this time.',
                         $env{'course.'.$cdom.'_'.$cnum.'.description'})
                    .'</span></p>'
                    .'<p>'.&mt('Please try again.').'</p>'
                    .'<p>'.$ferr.'</p>';
			    }
			    if (&Apache::lonnet::allowed('adv') eq 'F') { $tadv=1; }
			    &Apache::lonnet::appenv({'request.role.adv'=>$tadv});

			    if (($ferr) && ($tadv)) {
				&error_page($r,$ferr,$furl);
			    } else {
				# Check to see if the user is a CC entering a course 
				# for the first time
				my (undef, undef, $role, $courseid) = split(/\./, $envkey);
				if (substr($courseid, 0, 1) eq '/') {
				    $courseid = substr($courseid, 1);
				}
				$courseid =~ s/\//_/;
				if ((($role eq 'cc') || ($role eq 'co')) 
                                    && ($env{'course.' . $courseid .'.course.helper.not.run'})) { 
				    $furl = "/adm/helper/course.initialization.helper";
				    # Send the user to the course they selected
				} elsif ($env{'request.course.id'}) {
                                    if ($env{'form.destinationurl'}) {
                                        my $dest = $env{'form.destinationurl'};
                                        if ($env{'form.destsymb'} ne '') {
                                            my $esc_symb = &HTML::Entities::encode($env{'form.destsymb'},'"<>&');
                                            $dest .= '?symb='.$esc_symb;
                                        }
                                        &redirect_user($r, &mt('Entering [_1]',
                                                       $env{'course.'.$courseid.'.description'}),
                                                       $dest, $msg);
                                        return OK;
                                    }
				    if (&Apache::lonnet::allowed('whn',
								 $env{'request.course.id'})
					|| &Apache::lonnet::allowed('whn',
								    $env{'request.course.id'}.'/'
								    .$env{'request.course.sec'})
					) {
					my $startpage = &courseloadpage($courseid);
					unless ($startpage eq 'firstres') {         
					    $msg = &mt('Entering [_1] ...',
						       $env{'course.'.$courseid.'.description'});
					    &redirect_user($r, &mt('New in course'),
                                       '/adm/whatsnew?refpage=start', $msg);
					    return OK;
					}
				    }
				}
# Are we allowed to look at the first resource?
				if ($furl !~ m|^/adm/|) {
# Guess not ...
				    $furl=&Apache::lonpageflip::first_accessible_resource();
				}
                                $msg = &mt('Entering [_1] ...',
					   $env{'course.'.$courseid.'.description'});
				&redirect_user($r, &mt('Entering [_1]',
                               $env{'course.'.$courseid.'.description'}),
                               $furl, $msg);
			    }
			    return OK;
			}
		    }
                    #
                    # Send the user to the construction space they selected
                    if ($role =~ /^(au|ca|aa)$/) {
                        my $redirect_url = '/priv/';
                        if ($role eq 'au') {
                            $redirect_url.=$env{'user.name'};
                        } else {
                            $where =~ /\/(.*)$/;
                            $redirect_url .= $1;
                        }
                        $redirect_url .= '/';
                        &redirect_user($r,&mt('Entering Construction Space'),
                                       $redirect_url);
                        return OK;
                    }
                    if ($role eq 'dc') {
                        my $redirect_url = '/adm/menu/';
                        &redirect_user($r,&mt('Loading Domain Coordinator Menu'),
                                       $redirect_url);
                        return OK;
                    }
                    if ($role eq 'sc') {
                        my $redirect_url = '/adm/grades?command=scantronupload';
                        &redirect_user($r,&mt('Loading Data Upload Page'),
                                       $redirect_url);
                        return OK;
                    }
		}
            }
        }
    }


# =============================================================== No Roles Init

    &Apache::loncommon::content_type($r,'text/html');
    &Apache::loncommon::no_cache($r);
    $r->send_http_header;
    return OK if $r->header_only;

    my $crumbtext = 'User Roles';
    my $pagetitle = 'My Roles';
    my $recent = &mt('Recent Roles');
    my $show_course=&Apache::loncommon::show_course();
    if ($show_course) {
        $crumbtext = 'Courses';
        $pagetitle = 'My Courses';
        $recent = &mt('Recent Courses');
    }
    my $brcrum =[{href=>"/adm/roles",text=>$crumbtext}];
    my $swinfo=&Apache::lonmenu::rawconfig();
    my $start_page=&Apache::loncommon::start_page($pagetitle,undef,{bread_crumbs=>$brcrum});
    my $standby=&mt('Role selected. Please stand by.');
    $standby=~s/\n/\\n/g;
    my $noscript='<span class="LC_error">'.&mt('Use of LON-CAPA requires Javascript to be enabled in your web browser.').'<br />'.&mt('As this is not the case, most functionality in the system will be unavailable.').'</span><br />';

    $r->print(<<ENDHEADER);
$start_page
<br />
<noscript>
$noscript
</noscript>
<script type="text/javascript">
// <![CDATA[
$swinfo
window.focus();

active=true;

function enterrole (thisform,rolecode,buttonname) {
    if (active) {
	active=false;
        document.title='$standby';
        window.status='$standby';
	thisform.newrole.value=rolecode;
	thisform.submit();
    } else {
       alert('$standby');
    }   
}

function show_role_details (selectbox) {
  var role = \$(selectbox).val();
  var row = \$(selectbox).parents('tr');
  var rolestatus = \$(selectbox).children(':selected').attr('class');
  \$(row).children('td:first').removeClass().addClass(rolestatus);
  \$(row).find('div').addClass('LC_hidden');
  \$(row).next('tr').find('div').addClass('LC_hidden');
  \$('.' + role).removeClass('LC_hidden');
}
// ]]>
</script>
ENDHEADER

# ------------------------------------------ Get Error Message from Environment

    my ($fn,$priv,$nochoose,$error,$msg)=split(/:/,$env{'user.error.msg'});
    if ($env{'user.error.msg'}) {
	$r->log_reason(
   "$msg for $env{'user.name'} domain $env{'user.domain'} access $priv",$fn);
    }

# ------------------------------------------------- Can this user re-init, etc?

    my $advanced=$env{'user.adv'};
    &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},['tryagain']);
    my $tryagain=$env{'form.tryagain'};
    my $reinit=$env{'user.reinit'};
    delete $env{'user.reinit'};

# -------------------------------------------------------- Generate Page Output
# --------------------------------------------------------------- Error Header?
    if ($error) {
        $r->print("<h1>".&mt('LON-CAPA Access Control')."</h1>");
	$r->print("<!-- LONCAPAACCESSCONTROLERRORSCREEN --><hr /><pre>");
	if ($priv ne '') {
            $r->print(&mt('Access  : ').&Apache::lonnet::plaintext($priv)."\n");
	}
	if ($fn ne '') {
            $r->print(&mt('Resource: ').&Apache::lonenc::check_encrypt($fn)."\n");
	}
	if ($msg ne '') {
            $r->print(&mt('Action  : ').$msg."\n");
	}
	$r->print("</pre><hr />");
	my $url=$fn;
	my $last;
	if (tie(my %hash,'GDBM_File',$env{'request.course.fn'}.'_symb.db',
		&GDBM_READER(),0640)) {
	    $last=$hash{'last_known'};
	    untie(%hash);
	}
	if ($last) { $fn.='?symb='.&escape($last); }

	&Apache::londocs::changewarning($r,undef,'You have modified your course recently, [_1] may fix this access problem.',
					&Apache::lonenc::check_encrypt($fn));
    } else {
        if ($env{'user.error.msg'}) {
            if ($reinit) {
                $r->print(
 '<h3><span class="LC_error">'.
 &mt('As your session file for the course or community has expired, you will need to re-select it.').'</span></h3>');
            } else {
	        $r->print(
 '<h3><span class="LC_error">'.
 &mt('You need to choose another user role or enter a specific course or community for this function.').
 '</span></h3>');
	    }
        }
    }
# -------------------------------------------------------- Choice or no choice?
    if ($nochoose) {
	$r->print("<h2>".&mt('Sorry ...')."</h2>\n<span class='LC_error'>".
		  &mt('This action is currently not authorized.').'</span>'.
		  &Apache::loncommon::end_page());
	return OK;
    } else {
        if (($ENV{'REDIRECT_QUERY_STRING'}) && ($fn)) {
    	    $fn.='?'.$ENV{'REDIRECT_QUERY_STRING'};
        }
        $r->print('<form method="post" name="rolechoice" action="'.(($fn)?$fn:$r->uri).'">');
        $r->print('<input type="hidden" name="orgurl" value="'.$fn.'" />');
        $r->print('<input type="hidden" name="selectrole" value="1" />');
        $r->print('<input type="hidden" name="newrole" value="" />');
    }
    $r->rflush();

    my (%roletext,%sortrole,%roleclass,%futureroles,%timezones);
    my ($countactive,$countfuture,$inrole,$possiblerole) = 
        &gather_roles($then,$refresh,$now,$reinit,$nochoose,\%roletext,\%sortrole,\%roleclass,
                      \%futureroles,\%timezones,$loncaparev);

    $refresh = $now;
    &Apache::lonnet::appenv({'user.refresh.time'  => $refresh});
    if ($env{'user.adv'}) {
        $r->print('<p><label><input type="checkbox" name="showall"');
        if ($env{'form.showall'}) { $r->print(' checked="checked" '); }
        $r->print(' />'.&mt('Show all roles').'</label>'
                 .' <input type="submit" value="'.&mt('Update display').'" />'
                 .'</p>');
    } else {
        if ($countactive > 0) {
            $r->print(&Apache::loncoursequeueadmin::queued_selfenrollment());
            my $domdesc = &Apache::lonnet::domain($env{'user.domain'},'description');
            my $esc_dom = &HTML::Entities::encode($env{'user.domain'},'"<>&'); 
            $r->print(
                '<p>'
               .&mt('[_1]Visit the [_2]Course/Community Catalog[_3]'
                   .' to view all [_4] LON-CAPA courses and communities.'
                   ,'<b>'
                   ,'<a href="/adm/coursecatalog?showdom='.$esc_dom.'">'
                   ,'</a></b>',$domdesc)
               .'<br />'
               .&mt('If a course or community is [_1]not[_2] in your list of current courses and communities below,'
                   .' you may be able to enroll if self-enrollment is permitted.'
                   ,'<b>','</b>')
               .'</p>'
            );
        }
    }

# No active roles
    if ($countactive==0) {
	if ($inrole) {
	    $r->print('<h2>'.&mt('Currently no additional roles, courses or communities').'</h2>');
	} else {
	    $r->print('<h2>'.&mt('Currently no active roles, courses or communities').'</h2>');
	}
        &findcourse_advice($r);
        &requestcourse_advice($r); 
	$r->print('</form>');
        if ($countfuture) {
            $r->print(&mt('The following [quant,_1,role,roles] will become active in the future:',$countfuture));
            my $doheaders = &roletable_headers($r,\%roleclass,\%sortrole,
                                               $nochoose);
            &print_rolerows($r,$doheaders,\%roleclass,\%sortrole,\%dcroles,
                            \%roletext);
            my $tremark='';
            my $tbg;
            if ($env{'request.role'} eq 'cm') {
                $tbg="LC_roles_selected";
                $tremark=&mt('Currently selected.').' ';
            } else {
                $tbg="LC_roles_is";
            }
            $r->print(&Apache::loncommon::start_data_table_row()
                     .'<td class="'.$tbg.'">&nbsp;</td>'
                     .'<td colspan="8">'
                     .&mt('No role specified')
                     .'</td>'
                     .'<td>'.$tremark.'&nbsp;</td>'
                     .&Apache::loncommon::end_data_table_row()
            );

            $r->print(&Apache::loncommon::end_data_table());
        }
        $r->print(&Apache::loncommon::end_page());
	return OK;
    }
# ----------------------------------------------------------------------- Table

    if ($numdc > 0) {
        $r->print(&coursepick_jscript());
        $r->print(&Apache::loncommon::coursebrowser_javascript().
                  &Apache::loncommon::authorbrowser_javascript());
    }

    unless ((!&Apache::loncommon::show_course()) || ($nochoose) || ($countactive==1)) {
	$r->print("<h2>".&mt('Select a Course to Enter')."</h2>\n");
    }
    if ($env{'form.destinationurl'}) {
        $r->print('<input type="hidden" name="destinationurl" value="'.
                  $env{'form.destinationurl'}.'" />');
        if ($env{'form.destsymb'} ne '') {
            $r->print('<input type="hidden" name="destsymb" value="'.
                      $env{'form.destsymb'}.'" />');
        }
    }

    my $doheaders = &roletable_headers($r,\%roleclass,\%sortrole,$nochoose);
    if ($env{'environment.recentroles'}) {
        my %recent_roles =
               &Apache::lonhtmlcommon::get_recent('roles',$env{'environment.recentrolesn'});
	my $output='';
	foreach my $role (sort(keys(%recent_roles))) {
	    if (ref($roletext{'user.role.'.$role}) eq 'ARRAY') {
		$output.= &Apache::loncommon::start_data_table_row().
                          $roletext{'user.role.'.$role}->[0].
                          &Apache::loncommon::end_data_table_row();
                if ($roletext{'user.role.'.$role}->[1] ne '') {
                    $output .= &Apache::loncommon::continue_data_table_row().
                               $roletext{'user.role.'.$role}->[1].
                               &Apache::loncommon::end_data_table_row();
                }
                if ($role =~ m{dc\./($match_domain)/} 
		    && $dcroles{$1}) {
		    $output .= &adhoc_roles_row($1,'recent');
                }
	    } elsif ($numdc > 0) {
                unless ($role =~/^error\:/) {
                    my ($roletext,$role_text_end) = &display_cc_role('user.role.'.$role);
                    if ($roletext) {
                        $output.= &Apache::loncommon::start_data_table_row().
                                  $roletext.
                                  &Apache::loncommon::end_data_table_row();
                        if ($role_text_end) {
                            $output .= &Apache::loncommon::continue_data_table_row().
                                       $role_text_end.
                                       &Apache::loncommon::end_data_table_row();
                        }
                    }
                }
            }
	}
	if ($output) {
	    $r->print(&Apache::loncommon::start_data_table_empty_row()
                     .'<td align="center" colspan="5">'
                     .$recent
                     .'</td>'
                     .&Apache::loncommon::end_data_table_empty_row()
            );
	    $r->print($output);
            $doheaders ++;
	}
    }
    &print_rolerows($r,$doheaders,\%roleclass,\%sortrole,\%dcroles,\%roletext);
    if ($countactive > 1) {
        my $tremark='';
        my $tbg;
        if ($env{'request.role'} eq 'cm') {
            $tbg="LC_roles_selected";
            $tremark=&mt('Currently selected.').' ';
        } else {
                $tbg="LC_roles_is";
        }
        $r->print(&Apache::loncommon::start_data_table_row());
        unless ($nochoose) {
	    if ($env{'request.role'} ne 'cm') {
	        $r->print('<td class="'.$tbg.'"><input type="submit" value="'.
		          &mt('Select').'" name="cm" /></td>');
	    } else {
	        $r->print('<td class="'.$tbg.'">&nbsp;</td>');
	    }
        }
        $r->print('<td>'
                 .&mt('No role specified')
                 .'</td>'
                 .'<td colspan="7" >'.$tremark.'&nbsp;</td>'
                 .&Apache::loncommon::end_data_table_row()
        );
    } 
    $r->print(&Apache::loncommon::end_data_table());
    unless ($nochoose) {
	$r->print("</form>\n");
    }
# ------------------------------------------------------------ Privileges Info
    if (($advanced) && (($env{'user.error.msg'}) || ($error))) {
	$r->print('<hr /><h2>'.&mt('Current Privileges').'</h2>');
	$r->print(&privileges_info());
    }
    $r->print(&Apache::lonnet::getannounce());
    if ($advanced) {
        my $esc_dom = &HTML::Entities::encode($env{'user.domain'},'"<>&');
        $r->print('<p><small><i>'
                 .&mt('This LON-CAPA server is version [_1]',$r->dir_config('lonVersion'))
                 .'</i><br />'
                 .'<a href="/adm/logout">'.&mt('Logout').'</a>&nbsp;&nbsp;'
                 .'<a href="/adm/coursecatalog?showdom='.$esc_dom.'">'
                 .&mt('Course/Community Catalog')
                 .'</a></small></p>');
    }
    $r->print(&Apache::loncommon::end_page());
    return OK;
}

sub gather_roles {
    my ($then,$refresh,$now,$reinit,$nochoose,$roletext,$sortrole,$roleclass,$futureroles,$timezones,$loncaparev) = @_;
    my ($countactive,$countfuture,$inrole,$possiblerole) = (0,0,0,'');
    my $advanced = $env{'user.adv'};
    my $tryagain = $env{'form.tryagain'};
    my @ids = &Apache::lonnet::current_machine_ids();
    my %courses;
    my %course_roles;
    my %courserole_details;
    foreach my $envkey (sort(keys(%env))) {
        my $button = 1;
        my $switchserver='';
        my $switchwarning;
        my ($role_text,$role_text_end,$sortkey);
        if ($envkey=~/^user\.role\./) {
            my ($role,$where,$trolecode,$tstart,$tend,$tremark,$tstatus,$tpstart,$tpend);
            &Apache::lonnet::role_status($envkey,$then,$refresh,$now,\$role,\$where,
                                         \$trolecode,\$tstatus,\$tstart,\$tend);
            next if (!defined($role) || $role eq '' || $role =~ /^gr/);
            $tremark='';
            $tpstart='&nbsp;';
            $tpend='&nbsp;';
            if ($env{'request.role'} eq $trolecode) {
                $tstatus='selected';
            }
            my $tbg;
            if (($tstatus eq 'is')
                || ($tstatus eq 'selected')
                || ($tstatus eq 'future')
                || ($env{'form.showall'})) {
                my $timezone = &role_timezone($where,$timezones);
                if ($tstart) {
                    $tpstart=&Apache::lonlocal::locallocaltime($tstart,$timezone);
                }
                if ($tend) {
                    $tpend=&Apache::lonlocal::locallocaltime($tend,$timezone);
                }
                if ($tstatus eq 'is') {
                    $tbg='LC_roles_is';
                    $possiblerole=$trolecode;
                    $countactive++;
                } elsif ($tstatus eq 'future') {
                    $tbg='LC_roles_future';
                    $button=0;
                    $futureroles->{$trolecode} = $tstart.':'.$tend;
                    $countfuture ++;
                } elsif ($tstatus eq 'expired') {
                    $tbg='LC_roles_expired';
                    $button=0;
                } elsif ($tstatus eq 'will_not') {
                    $tbg='LC_roles_will_not';
                    $tremark.=&mt('Expired after logout.').' ';
                } elsif ($tstatus eq 'selected') {
                    $tbg='LC_roles_selected';
                    $inrole=1;
                    $countactive++;
                    $tremark.=&mt('Currently selected.').' ';
                }
                my $trole;
                if ($role =~ /^cr\//) {
                    my ($rdummy,$rdomain,$rauthor,$rrole)=split(/\//,$role);
                    if ($tremark) { $tremark.='<br />'; }
                    $tremark.=&mt('Customrole defined by [_1].',$rauthor.':'.$rdomain);
                }
                $trole=Apache::lonnet::plaintext($role);
                my $ttype;
                my $twhere;
                my ($tdom,$trest,$tsection)=
                    split(/\//,Apache::lonnet::declutter($where));
                # First, Co-Authorship roles
                if (($role eq 'ca') || ($role eq 'aa')) {
                    my $home = &Apache::lonnet::homeserver($trest,$tdom);
                    my $allowed=0;
                    foreach my $id (@ids) { if ($id eq $home) { $allowed=1; } }
                    if (!$allowed) {
                        $button=0;
                        $switchserver='otherserver='.$home.'&amp;role='.$trolecode;
                    }
                    #next if ($home eq 'no_host');
                    $home = &Apache::lonnet::hostname($home);
                    $ttype='Construction Space';
                    $twhere=&mt('User').': '.$trest.'<br />'.&mt('Domain').
                        ': '.$tdom.'<br />'.
                        ' '.&mt('Server').':&nbsp;'.$home;
                    $env{'course.'.$tdom.'_'.$trest.'.description'}='ca';
                    $tremark.=&Apache::lonhtmlcommon::authorbombs('/res/'.$tdom.'/'.$trest.'/');
                    $sortkey=$role."$trest:$tdom";
                } elsif ($role eq 'au') {
                    # Authors
                    my $home = &Apache::lonnet::homeserver
                        ($env{'user.name'},$env{'user.domain'});
                    my $allowed=0;
                    foreach my $id (@ids) { if ($id eq $home) { $allowed=1; } }
                    if (!$allowed) {
                        $button=0;
                        $switchserver='otherserver='.$home.'&amp;role='.$trolecode;
                    }
                    #next if ($home eq 'no_host');
                    $home = &Apache::lonnet::hostname($home);
                    $ttype='Construction Space';
                    $twhere=&mt('Domain').': '.$tdom.'<br />'.&mt('Server').
                        ':&nbsp;'.$home;
                    $env{'course.'.$tdom.'_'.$trest.'.description'}='ca';
                    $tremark.=&Apache::lonhtmlcommon::authorbombs('/res/'.$tdom.'/'.$env{'user.name'}.'/');
                    $sortkey=$role;
                } elsif ($trest) {
                    my $tcourseid=$tdom.'_'.$trest;
                    $ttype = &Apache::loncommon::course_type($tcourseid);
                    $trole = &Apache::lonnet::plaintext($role,$ttype,$tcourseid);

                    if ($env{'course.'.$tcourseid.'.description'}) {
                        my $home=$env{'course.'.$tcourseid.'.home'};
                        $twhere=$env{'course.'.$tcourseid.'.description'};
                        $sortkey=$role."\0".$tdom."\0".$twhere."\0".$envkey;
                        $twhere = &HTML::Entities::encode($twhere,'"<>&');
                        unless ($twhere eq &mt('Currently not available')) {
                            $twhere.=' <span class="LC_fontsize_small">'.
        &Apache::loncommon::syllabuswrapper(&mt('Syllabus'),$trest,$tdom).
                                    '</span>';
                            unless ($home && grep(/^\Q$home\E$/,@ids) && $loncaparev eq '') {
                                my $required = $env{'course.'.$tcourseid.'.internal.releaserequired'};
                                if ($required ne '') {
                                    ($switchserver,$switchwarning) = 
                                        &check_release_required($loncaparev,$tcourseid,$trolecode,$required);
                                    if ($switchserver || $switchwarning) {
                                        $button = 0;
                                    }
                                }
                            }
                        }
                    } else {
                        my %newhash=&Apache::lonnet::coursedescription($tcourseid);
                        if (%newhash) {
                            $sortkey=$role."\0".$tdom."\0".$newhash{'description'}.
                                "\0".$envkey;
                            $twhere=&HTML::Entities::encode($newhash{'description'},'"<>&').
                                    ' <span class="LC_fontsize_small">'.
                                     &Apache::loncommon::syllabuswrapper(&mt('Syllabus'),$trest,$tdom).
                                    '</span>';
                            $ttype = $newhash{'type'};
                            $trole = &Apache::lonnet::plaintext($role,$ttype,$tcourseid);
                            my $home = $newhash{'home'};
                            unless ($home && grep(/^\Q$home\E$/,@ids) && $loncaparev eq '') {
                                my $required = $newhash{'internal.releaserequired'};
                                if ($required ne '') {
                                    ($switchserver,$switchwarning) =
                                        &check_release_required($loncaparev,$tcourseid,$trolecode,$required);
                                    if ($switchserver || $switchwarning) {
                                        $button = 0;
                                    }
                                }
                            }
                        } else {
                            $twhere=&mt('Currently not available');
                            $env{'course.'.$tcourseid.'.description'}=$twhere;
                            $sortkey=$role."\0".$tdom."\0".$twhere."\0".$envkey;
                            $ttype = 'Unavailable';
                        }
                    }
                    if ($tsection) {
                        $twhere.='<br />'.&mt('Section').': '.$tsection;
                    }
                    if ($role ne 'st') { $twhere.="<br />".&mt('Domain').":".$tdom; }
                    #get all roles that are part of a course or community
                    $course_roles{$trolecode} = $tcourseid;
                    if (!exists($courses{$tcourseid})) {
                      $courses{$tcourseid} = $ttype;
                    }
                } elsif ($tdom) {
                    $ttype='Domain';
                    $twhere=$tdom;
                    $sortkey=$role.$twhere;
                } else {
                    $ttype='System';
                    $twhere=&mt('system wide');
                    $sortkey=$role.$twhere;
                }
                ($role_text,$role_text_end) =
                    &build_roletext($trolecode,$tdom,$trest,$tstatus,$tryagain,
                                    $advanced,$tremark,$tbg,$trole,$twhere,$tpstart,
                                    $tpend,$nochoose,$button,$switchserver,$reinit,$switchwarning,
                                    \%course_roles,\%courserole_details);
                if ($role_text) {
                  $roletext->{$envkey}=[$role_text,$role_text_end];
                  if (!$sortkey) {$sortkey=$twhere."\0".$envkey;}
                  $sortrole->{$sortkey}=$envkey;
                  $roleclass->{$envkey}=$ttype;
                }  
            }
        }
    }

    foreach my $course (keys(%courses)) {
      my ($course_text, $coursetext_end) = &build_coursetext($course,\%course_roles,\%courserole_details,$nochoose);
      $roletext->{$course}=[$course_text, $coursetext_end];
      my $sortkey = $course;
      $sortrole->{$sortkey} = $course;
      $roleclass->{$course} = $courses{$course};
    }
    return ($countactive,$countfuture,$inrole,$possiblerole);
}

sub role_timezone {
    my ($where,$timezones) = @_;
    my $timezone;
    if (ref($timezones) eq 'HASH') { 
        if ($where =~ m{^/($match_domain)/($match_courseid)}) {
            my $cdom = $1;
            my $cnum = $2;
            if ($cdom && $cnum) {
                if (!exists($timezones->{$cdom.'_'.$cnum})) {
                    my $tz;
                    if ($env{'course.'.$cdom.'_'.$cnum.'.description'}) {
                        $tz = $env{'course.'.$cdom.'_'.$cnum.'.timezone'};
                    } else {
                        my %timehash =
                            &Apache::lonnet::get('environment',['timezone'],$cdom,$cnum);
                        $tz = $timehash{'timezone'};
                    }
                    if ($tz eq '') {
                        if (!exists($timezones->{$cdom})) {
                            my %domdefaults = 
                                &Apache::lonnet::get_domain_defaults($cdom);
                            if ($domdefaults{'timezone_def'} eq '') {
                                $timezones->{$cdom} = 'local';
                            } else {
                                $timezones->{$cdom} = $domdefaults{'timezone_def'};
                            }
                        }
                        $timezones->{$cdom.'_'.$cnum} = $timezones->{$cdom};
                    } else {
                        $timezones->{$cdom.'_'.$cnum} = 
                            &Apache::lonlocal::gettimezone($tz);
                    }
                }
                $timezone = $timezones->{$cdom.'_'.$cnum};
            }
        } else {
            my ($tdom) = ($where =~ m{^/($match_domain)});
            if ($tdom) {
                if (!exists($timezones->{$tdom})) {
                    my %domdefaults = &Apache::lonnet::get_domain_defaults($tdom);
                    if ($domdefaults{'timezone_def'} eq '') {
                        $timezones->{$tdom} = 'local';
                    } else {
                        $timezones->{$tdom} = $domdefaults{'timezone_def'};
                    }
                }
                $timezone = $timezones->{$tdom};
            }
        }
        if ($timezone eq 'local') {
            $timezone = undef;
        }
    }
    return $timezone;
}

sub roletable_headers {
    my ($r,$roleclass,$sortrole,$nochoose) = @_;
    my $doheaders;
    if ((ref($sortrole) eq 'HASH') && (ref($roleclass) eq 'HASH')) {
        $r->print('<br />'
                 .&Apache::loncommon::start_data_table()
                 .&Apache::loncommon::start_data_table_header_row()
        );
        if (!$nochoose) { $r->print('<th>&nbsp;</th>'); }
        $r->print('<th>'.&mt('User Role').'</th>'
                 .'<th>'.&mt('Extent').'</th>'
                 .'<th>'.&mt('Start').' / '.&mt('End').'</th>'
                 .'<th><img src="/res/adm/pages/chat.png" alt="'.&mt('discussion').'" /></th>'
                 .'<th><img src="/adm/lonIcons/problem.gif" alt="'.&mt('problem').'" /></th>'
                 .'<th><img src="/res/adm/pages/indexericons/text.gif" alt="'.&mt('document').'" /></th>'
                 .'<th><img src="/res/adm/pages/grds.png" alt="'.&mt('handgrading').'" /></th>'
                 .'<th><img src="/res/adm/pages/indexericons/bomb.gif" alt="'.&mt('bomb').'" /></th>'
                 .&Apache::loncommon::end_data_table_header_row()
        );
        $doheaders=-1;
        my @roletypes = &roletypes();
        foreach my $type (@roletypes) {
            my $haverole=0;
            foreach my $which (sort {uc($a) cmp uc($b)} (keys(%{$sortrole}))) {
                if ($roleclass->{$sortrole->{$which}} =~ /^\Q$type\E/) {
                    $haverole=1;
                }
            }
            if ($haverole) { $doheaders++; }
        }
    }
    return $doheaders;
}

sub roletypes {
    my @types = ('Domain','Construction Space','Course','Community','Unavailable','System');
    return @types; 
}

sub print_rolerows {
    my ($r,$doheaders,$roleclass,$sortrole,$dcroles,$roletext) = @_;
    if ((ref($roleclass) eq 'HASH') && (ref($sortrole) eq 'HASH')) {
        my @types = &roletypes();
        foreach my $type (@types) {
            my $output;
            foreach my $which (sort {uc($a) cmp uc($b)} (keys(%{$sortrole}))) {
                if ($roleclass->{$sortrole->{$which}} =~ /^\Q$type\E/) {
                    if (ref($roletext) eq 'HASH') {
                        if (ref($roletext->{$sortrole->{$which}}) eq 'ARRAY') {
                            $output.= &Apache::loncommon::start_data_table_row().
                                      $roletext->{$sortrole->{$which}}->[0].
                                      &Apache::loncommon::end_data_table_row();
                            if ($roletext->{$sortrole->{$which}}->[1] ne '') {
                                $output .= &Apache::loncommon::continue_data_table_row().
                                           $roletext->{$sortrole->{$which}}->[1].
                                           &Apache::loncommon::end_data_table_row();
                            }
                        }
                        if ($sortrole->{$which} =~ m-dc\./($match_domain)/-) {
                            if (ref($dcroles) eq 'HASH') {
                                if ($dcroles->{$1}) {
                                    $output .= &adhoc_roles_row($1,'');
                                }
                            }
                        }
                    }
                }
            }
            if ($output) {
                if ($doheaders > 0) {
                    $r->print(&Apache::loncommon::start_data_table_empty_row()
                             .'<td align="center" colspan="9">'
                             .&mt($type)
                             .'</td>'
                             .&Apache::loncommon::end_data_table_empty_row()
                    );
                }
                $r->print($output);
            }
        }
    }
}

sub findcourse_advice {
    my ($r) = @_;
    my $domdesc = &Apache::lonnet::domain($env{'user.domain'},'description');
    my $esc_dom = &HTML::Entities::encode($env{'user.domain'},'"<>&');
    if (&Apache::lonnet::auto_run(undef,$env{'user.domain'})) {
        $r->print(&mt('If you were expecting to see an active role listed for a particular course in the [_1] domain, it may be missing for one of the following reasons:',$domdesc).'
<ul>
 <li>'.&mt('The course has yet to be created.').'</li>
 <li>'.&mt('Automatic enrollment of registered students has not been enabled for the course.').'</li>
 <li>'.&mt('You are in a section of course for which automatic enrollment in the corresponding LON-CAPA course is not active.').'</li>
 <li>'.&mt('The start date for automated enrollment has yet to be reached.').'</li>
 <li>'.&mt('You registered for the course recently and there is a time lag between the time you register, and the time this information becomes available for the update of LON-CAPA course rosters.').'</li>
 </ul>');
    } else {
        $r->print(&mt('If you were expecting to see an active role listed for a particular course, that course may not have been created yet.').'<br />');
    }
    $r->print('<h3>'.&mt('Self-Enrollment').'</h3>'.
              '<p>'.&mt('The [_1]Course/Community Catalog[_2] provides information about all [_3] classes for which LON-CAPA courses have been created, as well as any communities in the domain.','<a href="/adm/coursecatalog?showdom='.$esc_dom.'">','</a>',$domdesc).'<br />');
    $r->print(&mt('You can search for courses and communities which permit self-enrollment, if you would like to enroll in one.').'</p>'.
              &Apache::loncoursequeueadmin::queued_selfenrollment());
    return;
}

sub requestcourse_advice {
    my ($r) = @_;
    my $domdesc = &Apache::lonnet::domain($env{'user.domain'},'description');
    my $esc_dom = &HTML::Entities::encode($env{'user.domain'},'"<>&');
    my (%can_request,%request_doms);
    &Apache::lonnet::check_can_request($env{'user.domain'},\%can_request,\%request_doms);
    if (keys(%request_doms) > 0) {
        my ($types,$typename) = &Apache::loncommon::course_types();
        if ((ref($types) eq 'ARRAY') && (ref($typename) eq 'HASH')) { 
            $r->print('<h3>'.&mt('Request creation of a course or community').'</h3>'.
                      '<p>'.&mt('You have rights to request the creation of courses and/or communities in the following domain(s):').'<ul>');
            my (@reqdoms,@reqtypes);
            foreach my $type (sort(keys(%request_doms))) {
                push(@reqtypes,$type); 
                if (ref($request_doms{$type}) eq 'ARRAY') {
                    my $domstr = join(', ',map { &Apache::lonnet::domain($_) } sort(@{$request_doms{$type}}));
                    $r->print(
                        '<li>'
                       .&mt('[_1]'.$typename->{$type}.'[_2] in domain: [_3]',
                            '<i>',
                            '</i>',
                            '<b>'.$domstr.'</b>')
                       .'</li>'
                    );
                    foreach my $dom (@{$request_doms{$type}}) {
                        unless (grep(/^\Q$dom\E/,@reqdoms)) {
                            push(@reqdoms,$dom);
                        }
                    }
                }
            }
            my @showtypes;
            foreach my $type (@{$types}) {
                if (grep(/^\Q$type\E$/,@reqtypes)) {
                    push(@showtypes,$type);
                }
            }
            my $requrl = '/adm/requestcourse';
            if (@reqdoms == 1) {
                $requrl .= '?showdom='.$reqdoms[0];
            }
            if (@showtypes > 0) {
                $requrl.=(($requrl=~/\?/)?'&':'?').'crstype='.$showtypes[0];
            }
            if (@reqdoms == 1 || @showtypes > 0) {
                $requrl .= '&state=crstype&action=new';
            } 
            $r->print('</ul>'.&mt('Use the [_1]request form[_2] to submit a request for creation of a new course or community.','<a href="'.$requrl.'">','</a>').'</p>');
        }
    }
    return;
}

sub privileges_info {
    my ($which) = @_;
    my $output;

    $which ||= $env{'request.role'};

    foreach my $envkey (sort(keys(%env))) {
	next if ($envkey!~/^user\.priv\.\Q$which\E\.(.*)/);

	my $where=$1;
	my $ttype;
	my $twhere;
	my (undef,$tdom,$trest,$tsec)=split(m{/},$where);
	if ($trest) {
	    if ($env{'course.'.$tdom.'_'.$trest.'.description'} eq 'ca') {
		$ttype='Construction Space';
		$twhere='User: '.$trest.', Domain: '.$tdom;
	    } else {
		$ttype= &Apache::loncommon::course_type($tdom.'_'.$trest);
		$twhere=$env{'course.'.$tdom.'_'.$trest.'.description'};
		if ($tsec) {
		    my $sec_type = 'Section';
		    if (exists($env{"user.role.gr.$where"})) {
			$sec_type = 'Group';
		    }
		    $twhere.=' ('.$sec_type.': '.$tsec.')';
		}
	    }
	} elsif ($tdom) {
	    $ttype='Domain';
	    $twhere=$tdom;
	} else {
	    $ttype='System';
	    $twhere='/';
	}
	$output .= "\n<h3>".&mt($ttype).': '.$twhere.'</h3>'."\n<ul>";
	foreach my $priv (sort(split(/:/,$env{$envkey}))) {
	    next if (!$priv);

	    my ($prv,$restr)=split(/\&/,$priv);
	    my $trestr='';
	    if ($restr ne 'F') {
		$trestr.=' ('.
		    join(', ',
			 map { &Apache::lonnet::plaintext($_) } 
			     (split('',$restr))).') ';
	    }
	    $output .= "\n\t".
		'<li>'.&Apache::lonnet::plaintext($prv).$trestr.'</li>';
	}
	$output .= "\n".'</ul>';
    }
    return $output;
}


sub build_coursetext {
  my ($course,$course_roles,$courserole_details,$nochoose) = @_; 
  my %roles = %{$course_roles};
  my %details = %{$courserole_details};
  my ($coursetext,$coursetext_end);
  my ($selectbox, $buttons, $extent, $duration, $remark);
  my $hidden = 0;
  my $role_status;
  foreach my $role (keys(%roles)) {
    if ($details{$role}->[6] eq 'LC_roles_selected' && $roles{$role} eq $course) {
      $hidden = 1;
    }
  }
  my @feed_types = ('discussion', 'problem', 'document', 'handgrading', 'bomb');
  my %feeds;
  foreach my $role (keys(%roles)) {
    if ($roles{$role} eq $course) {
      my $class = $role;
      $class =~ s/\W//g; 
      my $active;
      my $display = ' LC_roles_details ';
      if ($details{$role}->[6] eq 'LC_roles_selected') {
        $active = ' selected="selected" ';
        $role_status = $details{$role}->[6];
      } elsif ($hidden) {
        $display .= ' LC_hidden ';
      } else { 
        $hidden = 1;
        $role_status = $details{$role}->[6];
      }
      $selectbox .= '<option '.$active.' class="'.$details{$role}->[6].'" value="'.$class.'" >'.$details{$role}->[0].'</option>';
      if ($details{$role}->[1] ne '') { 
        $buttons .= '<div class="'.$class.$display.'" >'.$details{$role}->[1].'</div>';
      }
      $extent .= '<div class="'.$class.$display.'" >'.$details{$role}->[2].'</div>';
      $duration .= '<div class="'.$class.$display.'" >'.$details{$role}->[3].'<br />'.$details{$role}[4].'</div>';  
      $remark .= '<div class="'.$class.$display.'" >'.$details{$role}->[5].'</div>';

      &Apache::lonfeeds::gather_feeds($course, $role, \@feed_types, \%feeds);
    }
  }
  
  my $colspan = $nochoose ? ' colspan="8" ' : ' colspan="9" ';
  unless ($nochoose) {
    $coursetext .= '<td class="'.$role_status.'" >'.$buttons.'&nbsp;</td>';
  }
  $coursetext .= '<td><select size="1" onchange="javascript:show_role_details(this);" >'.
                 $selectbox.'</select></td>'.                 
                 '<td>'.$extent.'</td>'.
                 '<td>'.$duration.'</td>';

  foreach my $type (@feed_types) {
    if ($feeds{$type}) {
      my $count = $feeds{$type}->entries;
      $coursetext .= '<td align="center" >'.$count.'</td>';
    } else {
      $coursetext .= '<td align="center" >-</td>';
    }
  }

  $coursetext_end = '<td'.$colspan.'>'.$remark.'&nbsp;</td>';
  return ($coursetext, $coursetext_end);
}


sub build_roletext {
    my ($trolecode,$tdom,$trest,$tstatus,$tryagain,$advanced,$tremark,$tbg,$trole,$twhere,$tpstart,$tpend,
        $nochoose,$button,$switchserver,$reinit,$switchwarning,$course_roles,$courserole_details) = @_;
    my ($roletext,$roletext_end);
    my $is_dc=($trolecode =~ m/^dc\./);
    my $rowspan=($is_dc) ? ''
                         : ' rowspan="2" ';
    my $colspan = ($nochoose) ? ' colspan="8" ' : ' colspan="9" ';
    my $buttontext = '';

    unless ($nochoose) {
        my $buttonname=$trolecode;
        $buttonname=~s/\W//g;
        if (!$button) {
            if ($switchserver) {
                $buttontext='<a href="/adm/switchserver?'.$switchserver.'">'
                          .&mt('Switch Server')
                          .'</a>';
            }
            if ($switchwarning) {
                if ($tremark eq '') {
                    $tremark = $switchwarning;
                } else {
                    $tremark .= '<br />'.$switchwarning;
                }
            }
        } elsif ($tstatus eq 'is') {
            $buttontext=  
                        '<input name="'.$buttonname.'" type="button" value="'.
                        &mt('Select').'" onclick="javascript:enterrole(this.form,\''.
                        $trolecode."','".$buttonname.'\');" />';
        } elsif ($tryagain) {
            $buttontext=
                '<input name="'.$buttonname.'" type="button" value="'.
                &mt('Try Selecting Again').'" onclick="javascript:enterrole(this.form,\''.
                        $trolecode."','".$buttonname.'\');" />';
        } elsif ($advanced) {
            $buttontext=
                '<input name="'.$buttonname.'" type="button" value="'.
                &mt('Re-Initialize').'" onclick="javascript:enterrole(this.form,\''.
                        $trolecode."','".$buttonname.'\');" />';
        } elsif ($reinit) {
            $buttontext= 
                '<input name="'.$buttonname.'" type="button" value="'.
                &mt('Re-Select').'" onclick="javascript:enterrole(this.form,\''.
                        $trolecode."','".$buttonname.'\');" />';
        } else {
            $buttontext=
                '<input name="'.$buttonname.'" type="button" value="'.
                &mt('Re-Select').'" onclick="javascript:enterrole(this.form,\''.
                        $trolecode."','".$buttonname.'\');" />';
        }
    }
    if ($trolecode !~ m/^(dc|ca|au|aa)\./) {
	$tremark.=&Apache::lonannounce::showday(time,1,
			 &Apache::lonannounce::readcalendar($tdom.'_'.$trest));
    }

    if (exists %{$course_roles}->{$trolecode}) {
      my @details = ($trole, $buttontext, $twhere, $tpstart, $tpend, $tremark, $tbg);
      %{$courserole_details}->{$trolecode} = \@details;
      return;
    }

    unless ($nochoose) {
      $roletext.='<td class="'.$tbg.'" >'.$buttontext.'</td>';
    }
    $roletext.='<td>'.$trole.'</td>'
              .'<td>'.$twhere.'</td>'
              .'<td>'.$tpstart.'<br />'.$tpend.'</td>'
              .'<td colspan="5" ></td>';
    if (!$is_dc) {
        $roletext_end = '<td'.$colspan.'>'.
                        $tremark.'&nbsp;'.
                        '</td>';
    }
    return ($roletext,$roletext_end);
}

sub check_needs_switchserver {
    my ($possiblerole) = @_;
    my $needs_switchserver;
    my ($role,$where) = split(/\./,$possiblerole,2);
    my (undef,$tdom,$twho) = split(/\//,$where);
    my ($server_status,$home);
    if (($role eq 'ca') || ($role eq 'aa')) {
        ($server_status,$home) = &check_author_homeserver($twho,$tdom);
    } else {
        ($server_status,$home) = &check_author_homeserver($env{'user.name'},
                                                          $env{'user.domain'});
    }
    if ($server_status eq 'switchserver') {
        $needs_switchserver = 1;
    }
    return $needs_switchserver;
}

sub check_author_homeserver {
    my ($uname,$udom)=@_;
    if (($uname eq '') || ($udom eq '')) {
        return ('fail','');
    }
    my $home = &Apache::lonnet::homeserver($uname,$udom);
    if (&Apache::lonnet::host_domain($home) ne $udom) {
        return ('fail',$home);
    }
    my @ids=&Apache::lonnet::current_machine_ids();
    if (grep(/^\Q$home\E$/,@ids)) {
        return ('ok',$home);
    } else {
        return ('switchserver',$home);
    }
}

sub check_fordc {
    my ($dcroles,$then) = @_;
    my $numdc = 0;
    if ($env{'user.adv'}) {
        foreach my $envkey (sort keys %env) {
            if ($envkey=~/^user\.role\.dc\.\/($match_domain)\/$/) {
                my $dcdom = $1;
                my $livedc = 1;
                my ($tstart,$tend)=split(/\./,$env{$envkey});
                if ($tstart && $tstart>$then) { $livedc = 0; }
                if ($tend   && $tend  <$then) { $livedc = 0; }
                if ($livedc) {
                    $$dcroles{$dcdom} = $envkey;
                    $numdc++;
                }
            }
        }
    }
    return $numdc;
}

sub adhoc_course_role {
    my ($refresh,$then) = @_;
    my ($cdom,$cnum,$crstype);
    $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
    $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
    $crstype = &Apache::loncommon::course_type();
    if (&check_forcc($cdom,$cnum,$refresh,$then,$crstype)) {
        my $setprivs;
        if (!defined($env{'user.role.'.$env{'form.switchrole'}})) {
            $setprivs = 1;
        } else {
            my ($start,$end) = split(/\./,$env{'user.role.'.$env{'form.switchrole'}});
            if (($start && ($start>$refresh || $start == -1)) ||
                ($end && $end<$then)) {
                $setprivs = 1;
            }
        }
        if ($setprivs) {
            if ($env{'form.switchrole'} =~ m-^(in|ta|ep|ad|st|cr)([\w/]*)\./\Q$cdom\E/\Q$cnum\E/?(\w*)$-) {
                my $role = $1;
                my $custom_role = $2;
                my $usec = $3;
                if ($role eq 'cr') {
                    if ($custom_role =~ m-^/$match_domain/$match_username/\w+$-) {
                        $role .= $custom_role;
                    } else {
                        return;
                    }
                }
                my (%userroles,%newrole,%newgroups,%group_privs);
                my %cgroups =
                    &Apache::lonnet::get_active_groups($env{'user.domain'},
                                            $env{'user.name'},$cdom,$cnum);
                foreach my $group (keys(%cgroups)) {
                    $group_privs{$group} =
                        $env{'user.priv.cc./'.$cdom.'/'.$cnum.'./'.$cdom.'/'.$cnum.'/'.$group};
                }
                $newgroups{'/'.$cdom.'/'.$cnum} = \%group_privs;
                my $area = '/'.$cdom.'/'.$cnum;
                my $spec = $role.'.'.$area;
                if ($usec ne '') {
                    $spec .= '/'.$usec;
                    $area .= '/'.$usec;
                }
                &Apache::lonnet::standard_roleprivs(\%newrole,$role,$cdom,$spec,$cnum,$area);
                &Apache::lonnet::set_userprivs(\%userroles,\%newrole,\%newgroups);
                my $adhocstart = $refresh-1;
                $userroles{'user.role.'.$spec} = $adhocstart.'.';
                &Apache::lonnet::appenv(\%userroles,[$role,'cm']);
            }
        }
    }
    return;
}

sub check_forcc {
    my ($cdom,$cnum,$refresh,$then,$crstype) = @_;
    my ($is_cc,$ccrole);
    if ($crstype eq 'Community') {
        $ccrole = 'co';
    } else {
        $ccrole = 'cc';
    }
    if ($cdom ne '' && $cnum ne '') {
        if (&Apache::lonnet::is_course($cdom,$cnum)) {
            my $envkey = 'user.role.'.$ccrole.'./'.$cdom.'/'.$cnum;
            if (defined($env{$envkey})) {
                $is_cc = 1;
                my ($tstart,$tend)=split(/\./,$env{$envkey});
                if ($tstart && $tstart>$refresh) { $is_cc = 0; }
                if ($tend   && $tend  <$then) { $is_cc = 0; }
            }
        }
    }
    return $is_cc;
}

sub check_release_required {
    my ($loncaparev,$tcourseid,$trolecode,$required) = @_;
    my ($switchserver,$warning);
    if ($required ne '') {
        my ($reqdmajor,$reqdminor) = ($required =~ /^(\d+)\.(\d+)$/);
        my ($major,$minor) = ($loncaparev =~ /^\'?(\d+)\.(\d+)\.[\w.\-]+\'?$/);
        if ($reqdmajor ne '' && $reqdminor ne '') {
            my $otherserver;
            if (($major eq '' && $minor eq '') || 
                (($reqdmajor > $major) || (($reqdmajor == $major) && ($reqdminor > $minor)))) {
                my ($userdomserver) = &Apache::lonnet::choose_server($env{'user.domain'});
                my $switchlcrev = 
                    &Apache::lonnet::get_server_loncaparev($env{'user.domain'},
                                                           $userdomserver);
                my ($swmajor,$swminor) = ($switchlcrev =~ /^\'?(\d+)\.(\d+)\.[\w.\-]+\'?$/);
                if (($swmajor eq '' && $swminor eq '') || ($reqdmajor > $swmajor) || 
                    (($reqdmajor == $swmajor) && ($reqdminor > $swminor))) {
                    my $cdom = $env{'course.'.$tcourseid.'.domain'};
                    if ($cdom ne $env{'user.domain'}) {
                        my ($coursedomserver,$coursehostname) = &Apache::lonnet::choose_server($cdom); 
                        my $serverhomeID = &Apache::lonnet::get_server_homeID($coursehostname);
                        my $serverhomedom = &Apache::lonnet::host_domain($serverhomeID);
                        my %defdomdefaults = &Apache::lonnet::get_domain_defaults($serverhomedom);
                        my %udomdefaults = &Apache::lonnet::get_domain_defaults($env{'user.domain'});
                        my $remoterev = &Apache::lonnet::get_server_loncaparev($serverhomedom,$coursedomserver);
                        my $canhost =
                            &Apache::lonnet::can_host_session($env{'user.domain'},
                                                              $coursedomserver,
                                                              $remoterev,
                                                              $udomdefaults{'remotesessions'},
                                                              $defdomdefaults{'hostedsessions'});

                        if ($canhost) {
                            $otherserver = $coursedomserver;
                        } else {
                            $warning = &mt('Requires LON-CAPA version [_1].',$env{'course.'.$tcourseid.'.internal.releaserequired'}).'<br />'. &mt("No suitable server could be found amongst servers in either your own domain or in the course's domain.");
                        }
                    } else {
                        $warning = &mt('Requires LON-CAPA version [_1].',$env{'course.'.$tcourseid.'.internal.releaserequired'}).'<br />'.&mt("No suitable server could be found amongst servers in your own domain (which is also the course's domain).");
                    }
                } else {
                    $otherserver = $userdomserver;
                }
            }
            if ($otherserver ne '') {
                $switchserver = 'otherserver='.$otherserver.'&amp;role='.$trolecode;
            }
        }
    }
    return ($switchserver,$warning);
}

sub update_content_constraints {
    my ($cdom,$cnum,$chome,$cid) = @_;
    my %curr_reqd_hash = &Apache::lonnet::userenvironment($cdom,$cnum,'internal.releaserequired');
    my ($reqdmajor,$reqdminor) = split(/\./,$curr_reqd_hash{'internal.releaserequired'}); 
    my %checkresponsetypes;
    foreach my $key (keys(%Apache::lonnet::needsrelease)) {
        my ($item,$name,$value) = split(/:/,$key);
        if ($item eq 'resourcetag') {
            if ($name eq 'responsetype') {
                $checkresponsetypes{$value} = $Apache::lonnet::needsrelease{$key}
            }
        }
    }
    my $navmap = Apache::lonnavmaps::navmap->new();
    if (defined($navmap)) {
        my %allresponses;
        foreach my $res ($navmap->retrieveResources(undef,sub { $_[0]->is_problem() },1,0)) {
            my %responses = $res->responseTypes();
            foreach my $key (keys(%responses)) {
                next unless(exists($checkresponsetypes{$key}));
                $allresponses{$key} += $responses{$key};
            }
        }
        foreach my $key (keys(%allresponses)) {
            my ($major,$minor) = split(/\./,$checkresponsetypes{$key});
            if (($major > $reqdmajor) || ($major == $reqdmajor && $minor > $reqdminor)) { 
                ($reqdmajor,$reqdminor) = ($major,$minor);
            } 
        }
        undef($navmap);
    }
    unless (($reqdmajor eq '') && ($reqdminor eq '')) {
        &Apache::lonnet::update_released_required($reqdmajor.'.'.$reqdminor,$cdom,$cnum,$chome,$cid);
    }
    return;
}

sub courselink {
    my ($dcdom,$rowtype) = @_;
    my $courseform=&Apache::loncommon::selectcourse_link
                   ('rolechoice','dccourse'.$rowtype.'_'.$dcdom,
                    'dcdomain'.$rowtype.'_'.$dcdom,'coursedesc'.$rowtype.'_'.
                    $dcdom,$dcdom,undef,'Course/Community');
    my $hiddenitems = '<input type="hidden" name="dcdomain'.$rowtype.'_'.$dcdom.'" value="'.$dcdom.'" />'.
                      '<input type="hidden" name="origdom'.$rowtype.'_'.$dcdom.'" value="'.$dcdom.'" />'.
                      '<input type="hidden" name="dccourse'.$rowtype.'_'.$dcdom.'" value="" />'.
                      '<input type="hidden" name="coursedesc'.$rowtype.'_'.$dcdom.'" value="" />';
    return $courseform.$hiddenitems;
}

sub coursepick_jscript {
    my %lt = &Apache::lonlocal::texthash(
                  plsu => "Please use the 'Select Course/Community' link to open a separate pick course window where you may select the course or community you wish to enter.",
                  youc => 'You can only use this screen to select courses and communities in the current domain.',
             );
    my $verify_script = <<"END";
<script type="text/javascript">
// <![CDATA[
function verifyCoursePick(caller) {
    var numbutton = getIndex(caller)
    var pickedCourse = document.rolechoice.elements[numbutton+4].value
    var pickedDomain = document.rolechoice.elements[numbutton+2].value
    if (document.rolechoice.elements[numbutton+2].value == document.rolechoice.elements[numbutton+3].value) {
        if (pickedCourse != '') {
            if (numbutton != -1) {
                var courseTarget = "cc./"+pickedDomain+"/"+pickedCourse
                document.rolechoice.elements[numbutton+1].name = courseTarget
                document.rolechoice.submit()
            }
        }
        else {
            alert("$lt{'plsu'}");
        }
    }
    else {
        alert("$lt{'youc'}")
    }
}
function getIndex(caller) {
    for (var i=0;i<document.rolechoice.elements.length;i++) {
        if (document.rolechoice.elements[i] == caller) {
            return i;
        }
    }
    return -1;
}
// ]]>
</script>
END
    return $verify_script;
}

sub coauthorlink {
    my ($dcdom,$rowtype) = @_;
    my $coauthorform=&Apache::loncommon::selectauthor_link('rolechoice',$dcdom);
    my $hiddenitems = '<input type="hidden" name="adhoccauname'.$rowtype.'_'.$dcdom.'" value="" />';
    return $coauthorform.$hiddenitems;
}

sub display_cc_role {
    my $rolekey = shift;
    my ($roletext,$roletext_end);
    my $advanced = $env{'user.adv'};
    my $tryagain = $env{'form.tryagain'};
    unless ($rolekey =~/^error\:/) {
        if ($rolekey =~ m{^user\.role\.(cc|co)\./($match_domain)/($match_courseid)$}) {
            my $ccrole = $1;
            my $tdom = $2;
            my $trest = $3;
            my $tcourseid = $tdom.'_'.$trest;
            my $trolecode = $ccrole.'./'.$tdom.'/'.$trest;
            my $twhere;
            my $ttype;
            my $tbg='LC_roles_is';
            my %newhash=&Apache::lonnet::coursedescription($tcourseid);
            if (%newhash) {
                $twhere=$newhash{'description'}.
                        ' <span style="LC_fontsize_small">'.
                        &Apache::loncommon::syllabuswrapper(&mt('Syllabus'),$trest,$tdom).
                        '</span>';
                $ttype = $newhash{'type'};
            } else {
                $twhere=&mt('Currently not available');
                $env{'course.'.$tcourseid.'.description'}=$twhere;
            }
            my $trole = &Apache::lonnet::plaintext($ccrole,$ttype,$tcourseid);
            $twhere.="<br />".&mt('Domain').":".$tdom;
            ($roletext,$roletext_end) = &build_roletext($trolecode,$tdom,$trest,'is',$tryagain,$advanced,'',$tbg,$trole,$twhere,'','','',1,'');
        }
    }
    return ($roletext,$roletext_end);
}

sub adhoc_roles_row {
    my ($dcdom,$rowtype) = @_;
    my $output = &Apache::loncommon::continue_data_table_row()
                 .' <td colspan="9">'
                 .&mt('[_1]Ad hoc[_2] roles in domain [_3] --'
                     ,'<span class="LC_cusr_emph">','</span>',$dcdom)
                 .' ';
    my $selectcclink = &courselink($dcdom,$rowtype);
    my $ccrole = &Apache::lonnet::plaintext('co',undef,undef,1);
    my $carole = &Apache::lonnet::plaintext('ca');
    my $selectcalink = &coauthorlink($dcdom,$rowtype);
    $output.=$ccrole.': '.$selectcclink
            .' | '.$carole.': '.$selectcalink.'</td>'
            .&Apache::loncommon::end_data_table_row();
    return $output;
}

sub recent_filename {
    my $area=shift;
    return 'nohist_recent_'.&escape($area);
}

sub courseloadpage {
    my ($courseid) = @_;
    my $startpage;
    my %entry_settings = &Apache::lonnet::get('nohist_whatsnew',
					      [$courseid.':courseinit']);
    my ($tmp) = %entry_settings;
    unless ($tmp =~ /^error: 2 /) {
        $startpage = $entry_settings{$courseid.':courseinit'};
    }
    if ($startpage eq '') {
        if (exists($env{'environment.course_init_display'})) {
            $startpage = $env{'environment.course_init_display'};
        }
    }
    return $startpage;
}

1;
__END__

=head1 NAME

Apache::lonroles - User Roles Screen

=head1 SYNOPSIS

Invoked by /etc/httpd/conf/srm.conf:

 <Location /adm/roles>
 PerlAccessHandler       Apache::lonacc
 SetHandler perl-script
 PerlHandler Apache::lonroles
 ErrorDocument     403 /adm/login
 ErrorDocument	  500 /adm/errorhandler
 </Location>

=head1 OVERVIEW

=head2 Choosing Roles

C<lonroles> is a handler that allows a user to switch roles in
mid-session. LON-CAPA attempts to work with "No Role Specified", the
default role that a user has before selecting a role, as widely as
possible, but certain handlers for example need specification which
course they should act on, etc. Both in this scenario, and when the
handler determines via C<lonnet>'s C<&allowed> function that a certain
action is not allowed, C<lonroles> is used as error handler. This
allows the user to select another role which may have permission to do
what they were trying to do.

=begin latex

\begin{figure}
\begin{center}
\includegraphics[width=0.45\paperwidth,keepaspectratio]{Sample_Roles_Screen}
  \caption{\label{Sample_Roles_Screen}Sample Roles Screen} 
\end{center}
\end{figure}

=end latex

=head2 Role Initialization

The privileges for a user are established at login time and stored in the session environment. As a consequence, a new role does not become active till the next login. Handlers are able to query for privileges using C<lonnet>'s C<&allowed> function. When a user first logs in, their role is the "common" role, which means that they have the sum of all of their privileges. During a session it might become necessary to choose a particular role, which as a consequence also limits the user to only the privileges in that particular role.

=head1 INTRODUCTION

This module enables a user to select what role he wishes to
operate under (instructor, student, teaching assistant, course
coordinator, etc).  These roles are pre-established by the actions
of upper-level users.

This is part of the LearningOnline Network with CAPA project
described at http://www.lon-capa.org.

=head1 HANDLER SUBROUTINE

This routine is called by Apache and mod_perl.

=over 4

=item *

Roles Initialization (yes/no)

=item *

Get Error Message from Environment

=item *

Who is this?

=item *

Generate Page Output

=item *

Choice or no choice

=item *

Table

=item *

Privileges

=back

=cut

--ehlerst1300549633--