[LON-CAPA-cvs] cvs: loncom /lonnet/perl lonnet.pm

[raeburn]

raeburn		Sun Oct  6 14:20:37 2013 EDT

  Modified files:              
    /loncom/lonnet/perl	lonnet.pm 
  Log:
  - &get_domain_defaults() can take a second (optional) arg -- $ignore_cache
    which causes domain configuration to be loaded from configuration.db or
    domain.tab, and not cache.
  - Update POD for &get_domain_defaults().
  
  
Index: loncom/lonnet/perl/lonnet.pm
diff -u loncom/lonnet/perl/lonnet.pm:1.1239 loncom/lonnet/perl/lonnet.pm:1.1240
--- loncom/lonnet/perl/lonnet.pm:1.1239	Sun Sep 29 14:15:08 2013
+++ loncom/lonnet/perl/lonnet.pm	Sun Oct  6 14:20:36 2013
@@ -1,7 +1,7 @@
 # The LearningOnline Network
 # TCP networking package
 #
-# $Id: lonnet.pm,v 1.1239 2013/09/29 14:15:08 raeburn Exp $
+# $Id: lonnet.pm,v 1.1240 2013/10/06 14:20:36 raeburn Exp $
 #
 # Copyright Michigan State University Board of Trustees
 #
@@ -1984,12 +1984,14 @@
 # ------------- Get Authentication, Language and User Tools Defaults for Domain
 
 sub get_domain_defaults {
-    my ($domain) = @_;
+    my ($domain,$ignore_cache) = @_;
     my $cachetime = 60*60*24;
-    my ($result,$cached)=&is_cached_new('domdefaults',$domain);
-    if (defined($cached)) {
-        if (ref($result) eq 'HASH') {
-            return %{$result};
+    unless ($ignore_cache) {
+        my ($result,$cached)=&is_cached_new('domdefaults',$domain);
+        if (defined($cached)) {
+            if (ref($result) eq 'HASH') {
+                return %{$result};
+            }
         }
     }
     my %domdefaults;
@@ -13220,15 +13222,90 @@
 
 =item * 
 
-get_domain_defaults($target_domain) : returns hash with defaults for
-authentication and language in the domain. Keys are: auth_def, auth_arg_def,
-lang_def; corresponsing values are authentication type (internal, krb4, krb5,
-or localauth), initial password or a kerberos realm, language (e.g., en-us).
-Values are retrieved from cache (if current), or from domain's configuration.db
-(if available), or lastly from values in lonTabs/dns_domain,tab, 
-or lonTabs/domain.tab. 
+get_domain_defaults($target_domain,$ignore_cache) : returns hash with defaults 
+for: authentication, language, quotas, timezone, date locale, and portal URL in
+the target domain.
+
+May also include additional key => value pairs for the following groups:
+
+=over
+
+=item
+disk quotas (MB allocated by default to portfolios and authoring spaces).
+
+=over
+
+=item defaultquota, authorquota
+
+=back
+
+=item
+tools (availability of aboutme page, blog, webDAV access for authoring spaces,
+portfolio for users).
+
+=over
+
+=item
+aboutme, blog, webdav, portfolio
+
+=back
+
+=item
+requestcourses: ability to request courses, and how requests are processed.
+
+=over
+
+=item
+official, unofficial, community
+
+=back
+
+=item
+inststatus: types of institutional affiliation, and order in which they are displayed.
+
+=over
+
+=item
+inststatustypes, inststatusorder
+
+=back
+
+=item
+coursedefaults: can PDF forms can be created, default credits for courses, default quotas (MB)
+for course's uploaded content.
+
+=over
+
+=item
+canuse_pdfforms, officialcredits, unofficialcredits, officialquota, unofficialquota, communityquota
+
+=back
+
+=item
+usersessions: set options for hosting of your users in other domains, and hosting of users from other domains
+on your servers.
+
+=over
+
+=item 
+remotesessions, hostedsessions
+
+=back
+
+=back
+
+In cases where a domain coordinator has never used the "Set Domain Configuration"
+utility to create a configuration.db file on a domain's primary library server 
+only the following domain defaults: auth_def, auth_arg_def, lang_def
+-- corresponding values are authentication type (internal, krb4, krb5,
+or localauth), initial password or a kerberos realm, language (e.g., en-us) -- 
+will be available. Values are retrieved from cache (if current), unless the
+optional $ignore_cache arg is true, or from domain's configuration.db (if available),
+or lastly from values in lonTabs/dns_domain,tab, or lonTabs/domain.tab.
+
+Typical usage:
 
-%domdefaults = &get_auth_defaults($target_domain);
+%domdefaults = &get_domain_defaults($target_domain);
 
 =back