[LON-CAPA-cvs] cvs: loncom(bz6209) /interface lonsyllabus.pm

faziophi faziophi@source.lon-capa.org
Mon, 15 Feb 2010 05:31:00 -0000


This is a MIME encoded message

--faziophi1266211860
Content-Type: text/plain

faziophi		Mon Feb 15 05:31:00 2010 EDT

  Modified files:              (Branch: bz6209)
    /loncom/interface	lonsyllabus.pm 
  Log:
  Work-in-progress commit for bug 6209.
  
  --> Adds capability for arbitrary fields in the data structures for 
      lonsyllabus.
  
  DESCRIPTION:
  
  Existing 2.x fields are converted to new 'data.fields.TIME_PROCESS_INT'
  DB entries, and a 'data.old_new_map' entry  maps old 2.x field names to 
  their new 3.x equivalents to preserve backwards compatibility. 
  Field order and display is maintained by a 'data.fields' DB entry, which is
   a frozen array of 3.x field entry IDs.
  
  When encountering a document with no 'data.fields' entry, the 2.x structure
  is converted to a new 3.x data structure as above.  This indicates a
  document never touched by 3.x.
  
  Saves of 3.x documents are maintained by updating both the existing 
  'uploaded.lastmodified' DB entry as well as a new 'properties.last_modified'
  entry which is exclusive to 3.x. Mismatched timestamps indicate that a 3.x
  document has been further changed in 2.x -- in that event, if an existing
  field (ex. 'aaa_instructorinfo') has an equivalent, the corresponding 3.x 
  field is updated; else the field is appended to the 3.x document and
  a conflict fail flag is enabled.
  
  Each new 3.x field DB entry is a frozen hash with structure as follows:
      $field{title} = Name of field
      $field{content} = Content of field
      $field{type} = Type of field, to determine parsing/saving attitude
          - TYPE_TEXT_HTML  -- HTML content
          - TYPE_TEXT_PLAIN  -- plain content
          - TYPE_URL_INCLUDE  -- URLs to be included the course
  
  NOTES:
  
  --> There is still a lot of DEBUG code and output in here.
  --> To reset a syllabus from 3.x to a 2.x document, add "&forceflush=1"
      to the edit syllabus page.
  --> While "Delete" links appear with individual fields once saved in 
      3.x format, these links do not function yet.
  --> A temporary function, &print_template_new_fields(), takes the place
      of &Apache::lontemplate::print_template_fields().
  --> Documentation will get better over time.
  --> Happy belated Valentine's Day.
  
  
  
--faziophi1266211860
Content-Type: text/plain
Content-Disposition: attachment; filename="faziophi-20100215053100.txt"

Index: loncom/interface/lonsyllabus.pm
diff -u loncom/interface/lonsyllabus.pm:1.106 loncom/interface/lonsyllabus.pm:1.106.2.1
--- loncom/interface/lonsyllabus.pm:1.106	Sun Jan 31 06:03:55 2010
+++ loncom/interface/lonsyllabus.pm	Mon Feb 15 05:31:00 2010
@@ -1,7 +1,7 @@
 # The LearningOnline Network
 # Syllabus
 #
-# $Id: lonsyllabus.pm,v 1.106 2010/01/31 06:03:55 faziophi Exp $
+# $Id: lonsyllabus.pm,v 1.106.2.1 2010/02/15 05:31:00 faziophi Exp $
 #
 # Copyright Michigan State University Board of Trustees
 #
@@ -40,6 +40,16 @@
 use Apache::lonhtmlcommon;
 use Apache::lonspeller();
 use HTML::Entities();
+use Digest::MD5 qw(md5_hex);
+use Storable qw(freeze thaw);
+
+# These are strings representing types of fields
+# that will used to parse/display a field correctly
+use constant {
+	TYPE_TEXT_HTML => 'html',  #<-- default
+	TYPE_TEXT_PLAIN => 'text',
+	TYPE_URL_INCLUDE => 'include-url',
+};
 
 sub handler {
     my $r = shift;
@@ -52,7 +62,7 @@
     my (undef,undef,$cdom,$cnum)=split(/\//,$r->uri);
 # ------------------------------------------------------------ Get query string
     &Apache::loncommon::get_unprocessed_cgi
-                        ($ENV{'QUERY_STRING'},['forcestudent','register','forceedit','wrapperdisplay']);
+                        ($ENV{'QUERY_STRING'},['delete', 'field', 'forcestudent','register','forceedit','forceflush','wrapperdisplay']);
 # ----------------------------------------------------- Is this even a course?
     my $homeserver=&Apache::lonnet::homeserver($cnum,$cdom);
     if ($homeserver eq 'no_host') {
@@ -66,15 +76,13 @@
     my %courseenv=&Apache::lonnet::dump('environment',$cdom,$cnum);
 
 # ------------------------------------------------------------ Print the screen
-
     if ($target eq 'tex') {
         $r->print(&Apache::lonprintout::print_latex_header($env{'form.latex_type'}));
     }
+    
 # -------------------------------------------------- Let's see who handles this
     my $externalsyllabus=$courseenv{'externalsyllabus'};
-
     if ($externalsyllabus=~/\w/) {
-
        if ($env{'form.wrapperdisplay'} eq 'menu') {
            $r->print(&Apache::lonwrapper::simple_menu());
        } else {
@@ -84,8 +92,7 @@
        return OK;
     }
 
-# ------------------------------ The buck stops here: internal syllabus display
-# --------------------------------------------------------- The syllabus fields
+# --------------------------------------------------------- The old syllabus fields
     my %syllabusfields=&Apache::lonlocal::texthash(
        'aaa_instructorinfo' => 'Instructor Information',
        'bbb_description'    => 'Course Description',
@@ -102,6 +109,7 @@
        'jjj_weblinks'       => 'Web Links',
        'kkk_textbook'       => 'Textbook',
        'lll_includeurl'     => 'URLs To Include in Syllabus');
+       
 # --------------------------------------------------------------- Force Student
     my $forcestudent='';
     if ($env{'form.forcestudent'}) { $forcestudent='student'; };
@@ -164,70 +172,153 @@
         }
     }
 # ---------------------------------------------------------- Load syllabus info
-    my %syllabus=&Apache::lonnet::dump('syllabus',$cdom,$cnum);
-    my $allowed=0;
+    my %syllabus=&Apache::lonnet::dump('syllabus',$cdom,$cnum);  # load db
+    my $allowed=0;  # can we edit this page?
     my $privileged=0;
+    my %data;
+    if ($env{'form.forceflush'}) {
+    	delete $syllabus{'data.fields'};
+    	&Apache::lonnet::del('syllabus', ['data.fields'], $cdom, $cnum);
+    	delete $syllabus{'properties.v2_conflict'};
+    	&Apache::lonnet::del('syllabus', ['properties.v2_conflict'], $cdom, $cnum);
+    	delete $syllabus{'properties.v2_conflict_fail'};
+    	&Apache::lonnet::del('syllabus', ['properties.v2_conflict_fail'], $cdom, $cnum);
+    	delete $syllabus{'properties.last_modified'};
+    	&Apache::lonnet::del('syllabus', ['properties.last_modified'], $cdom, $cnum);
+    	delete $syllabus{'properties.v2_converted'};
+    	&Apache::lonnet::del('syllabus', ['properties.v2_converted'], $cdom, $cnum);
+    	delete $syllabus{'data.old_new_map'};
+    	&Apache::lonnet::del('syllabus', ['data.old_new_map'], $cdom, $cnum);
+		%syllabus=&Apache::lonnet::dump('syllabus',$cdom,$cnum);  # load db
+    	$r->print("Flushed syllabus DB file.<br />");
+    	$r->print("Syllabus conflict: ".$syllabus{'properties.v2_conflict'}."<br />");
+   	}
+   	$r->print("Existing fields: ".$syllabus{'data.fields'}."<br />");
+   	$r->print("Old-new map: ".$syllabus{'data.old_new_map'}."<br />");
+    if (!exists($syllabus{'data.fields'})) {
+    	# convert existing 2.x data to new DB fields
+    	# which become new primary data source for document
+		%data = %{convert_from_v2($r, \%syllabus, \%syllabusfields, 0)};
+		$r->print("New fields order: ".$data{'data.fields'}."<br />");
+		&Apache::lonnet::put('syllabus',\%data,$cdom,$cnum);
+    } elsif (  !exists($syllabus{'properties.v2_converted'}) && 
+    		   exists($syllabus{'uploaded.lastmodified'}) &&
+    		   exists($syllabus{'properties.last_modified'}) &&
+    		   ($syllabus{'uploaded.lastmodified'} !=
+    		   $syllabus{'properties.last_modified'})) {
+    	# if the document has been saved in 3.x and later edited in 
+    	# 2.x, reconvert the existing document, with extra warning
+    	%data = %{convert_from_v2($r, \%syllabus, \%syllabusfields, 1)};
+    	delete $data{'properties.v2_converted'};
+    	&Apache::lonnet::del('syllabus', ['properties.v2_converted'], $cdom, $cnum);
+    	$data{'properties.v2_conflict'} = 1;
+		&Apache::lonnet::put('syllabus',\%data,$cdom,$cnum);    	
+    } else {
+    	%data = %syllabus;
+    	
+    }
 
-# This handler might be called anonymously ...
 # ----------------------------------------------------- Only if not public call
-    if ($env{'user.environment'}) {
-# does this user have privileges to post, etc?
+    if ($env{'user.environment'}) { # does this user have privileges to post, etc?
         if ($env{'request.course.id'}
         && $cdom eq $env{'course.'.$env{'request.course.id'}.'.domain'}
         && $cnum eq $env{'course.'.$env{'request.course.id'}.'.num'}) {
             $allowed=&Apache::lonnet::allowed('mdc',$env{'request.course.id'});
             $privileged=$allowed;
-            if (($syllabus{'uploaded.lastmodified'}) && (!$forceedit)) {
+            if (($data{'uploaded.lastmodified'}) && (!$forceedit)) {
                 $forcestudent='student';
             }
             if ($forcestudent or $target eq 'tex') { $allowed=0; }
         }
 		#store what the user typed in
+		my @fields = @{thaw($data{'data.fields'})};
+		if (($allowed) && ($env{'form.delete'})) {
+			my $field = $env{'form.delete'};
+			chomp($field);
+			#allow only numbers, underscores
+			$field=~s/[^0-9_]//g;
+			#check if the field exists
+			#do not delete if file in v2 conversion mode
+			if (exists($data{'data.field.'.$field}) &&
+				!exists($data{'properties.v2_converted'})) {
+				$r->print("Field can be deleted.<br />");
+			}
+		}
         if (($allowed) && ($env{'form.storesyl'})) {
-            foreach my $syl_field (keys(%syllabusfields)) {
+            foreach my $syl_field (@fields) {
                 my $field=$env{'form.'.$syl_field};
-                chomp($field);
-                $field=~s/\s+$//s;
-                $field=~s/^\s+//s;
-                $field=~s/\<br\s*\/*\>$//s;
-                $field=&Apache::lonfeedback::clear_out_html($field,1);
-				#here it will be stored
-                $syllabus{$syl_field}=$field;
-                if ($syl_field eq 'lll_includeurl') { # clean up included URLs
-                    my $field='';
-                    foreach my $value (split(/\n/,$syllabus{$syl_field})) {
-                        my $url=$value;
-# get rid of leading and trailing spaces
-                        $url=~s/^\s+//;
-                        $url=~s/\s+$//;
-                        if ($url=~m|^https?\://([^/]+)/(.+)$|) {
-                            my $host = $1;
-                            my $remainder=$2;
-# remove the hostname from internal URLs
-                            my $hostname = &Apache::lonnet::hostname($host);
-                            my %all_hostnames = &Apache::lonnet::all_hostnames();
-                            foreach my $possible_host (keys(%all_hostnames)) {
-                                if ($possible_host =~ /\Q$hostname\E/i) {
-                                    $url=$remainder;
-                                }
-                            }
-                        }
-# norm internal URLs
-                        unless ($url=~/^https?\:/) {
-                            $url=&Apache::lonnet::clutter($url);
-                        }
-# re-assemble field
-                        if ($url) {
-                            $field.=$url."\n";
-                        }
-                    }
-                    $syllabus{$syl_field}=$field;
-                }
+                my $type;
+                my %field_hash;
+                # only update a field if it already exists!
+                if (exists($data{'data.field.'.$syl_field})) {
+                	$r->print("Creating/updated field ".$syl_field."<br />");
+                	%field_hash = exists($data{'data.field.'.$syl_field}) ?
+                						%{thaw($data{'data.field.'.$syl_field})} :
+                						();
+                	$type = exists($field_hash{type}) ? $field_hash{type} : TYPE_TEXT_HTML;
+					chomp($field);
+					$field=~s/\s+$//s;
+					$field=~s/^\s+//s;
+					$field=~s/\<br\s*\/*\>$//s;
+					$field=&Apache::lonfeedback::clear_out_html($field,1);
+					$field_hash{content}=$field;
+					if ($type eq TYPE_URL_INCLUDE) { # clean up included URLs
+						my $field='';
+						foreach my $value (split(/\n/,$field_hash{content})) {
+							my $url=$value;
+							# get rid of leading and trailing spaces
+							$url=~s/^\s+//;
+							$url=~s/\s+$//;
+							if ($url=~m|^https?\://([^/]+)/(.+)$|) {
+								my $host = $1;
+								my $remainder=$2;
+								# remove the hostname from internal URLs
+								my $hostname = &Apache::lonnet::hostname($host);
+								my %all_hostnames = &Apache::lonnet::all_hostnames();
+								foreach my $possible_host (keys(%all_hostnames)) {
+									if ($possible_host =~ /\Q$hostname\E/i) {
+										$url=$remainder;
+									}
+								}
+							}
+							# norm internal URLs
+							unless ($url=~/^https?\:/) {
+								$url=&Apache::lonnet::clutter($url);
+							}
+							# re-assemble field
+							if ($url) {
+								$field.=$url."\n";
+							}
+						}
+	    	               $field_hash{content}=$field;
+		                   $field_hash{type}=TYPE_URL_INCLUDE;
+					}
+					$data{'data.field.'.$syl_field} = freeze(\%field_hash);
+				} 
+            }
+            $data{'uploaded.domain'}=$env{'user.domain'};
+            $data{'uploaded.name'}=$env{'user.name'};
+            my $time = $^T;
+            $data{'uploaded.lastmodified'}=$time;
+            $data{'properties.last_modified'}=$time;
+            delete $data{'properties.v2_converted'};
+            delete $data{'properties.v2_conflict'};
+            delete $data{'properties.v2_conflict_fail'};
+            &Apache::lonnet::del('syllabus', ['properties.v2_converted', 
+            	'properties.v2_conflict', 'properties.v2_conflict_fail'], $cdom, $cnum);
+            	
+            #2.x compatibility: write to old fields with new mapped fields
+            my %old_new_map = %{thaw($data{'data.old_new_map'})};
+            foreach my $old_field (keys(%old_new_map)) {
+            	$r->print("Looking for: ".$old_field." at ".$old_new_map{$old_field}."<br />");
+            	if (exists($data{'data.field.'.$old_new_map{$old_field}})) {
+            		$r->print("updating old field ".$old_field."<br />");
+            		my %new_field = %{thaw($data{'data.field.'.$old_new_map{$old_field}})};
+            		$data{$old_field} = $new_field{content};
+            	}
             }
-            $syllabus{'uploaded.domain'}=$env{'user.domain'};
-            $syllabus{'uploaded.name'}=$env{'user.name'};
-            $syllabus{'uploaded.lastmodified'}=time;
-            &Apache::lonnet::put('syllabus',\%syllabus,$cdom,$cnum);
+              
+            &Apache::lonnet::put('syllabus',\%data,$cdom,$cnum);
         }
     }
 
@@ -306,6 +397,18 @@
                   :'')
              .'\\\\');
     }
+    if ($allowed && $data{'properties.v2_converted'} == 1) {
+    	$r->print("<em>This document was created with LON-CAPA 2.x.  Modifying it may cause it to not display correctly on older servers.</em><br/>");
+	}
+	if ($allowed && $data{'properties.v2_conflict'} == 1) {
+		$r->print("<em>This document was saved with LON-CAPA 3.x, then further edited in LON-CAPA 2.x.</em><br/>");
+		if ($data{'properties.v2_conflict_fail'} == 1) {
+			$r->print("<em>Some fields in LON-CAPA 2.x no longer have an equivalent in LON-CAPA 3.x.  These fields were appended; some fields may be duplicated or not match.</em><br />");
+		} else {
+			$r->print("<em>These changes were automatically transferred to LON-CAPA 3.x</em>");
+		}
+	}
+
 #----------------------------Print Headtitle
     if ($target ne 'tex') {
         $r->print('<h1>'.$courseenv{'description'}.'</h1>');
@@ -314,6 +417,7 @@
         $r->print('\noindent{\large\textbf{'.$courseenv{'description'}.'}}\\\\\\\\\textbf{'.
         &Apache::lonnet::domain($cdom,'description').'}\\\\');
     }
+
 # -------------------------------------------------------- Get course personnel
     my %coursepersonnel=&Apache::lonnet::get_course_adv_roles($cdom.'/'.$cnum);
     if ($target ne 'tex') {
@@ -376,6 +480,7 @@
     } else {
         $r->print(&Apache::lonxml::xmlparse($r,'tex',$day));
     }
+    
 # ---------------------------------------------------------------- Get syllabus
     if (($syllabus{'uploaded.lastmodified'}) || ($allowed)) {
         if ($allowed) {
@@ -384,11 +489,10 @@
         }
         my @htmlids=();
 		my $url_include_handler = sub {
-			my ($r, $field, $message, $group, $data_ref, $fields_ref, $target, $allowed) = @_;
-			my %data = %{$data_ref};
-			my %fields = %{$fields_ref};
-			my $urls=$message;
-			$message='';
+			my ($r, $field, $json_ref, $group, $target, $allowed) = @_;
+			my $message = $json_ref->{items}{$field}{content};
+			my $title = $json_ref->{items}{$field}{title};
+			my $urls = $message;
 			foreach my $filelink (split(/\n/,$urls)) {
 				my $output='';
 			   # embed style?
@@ -400,6 +504,7 @@
 					$output='<img src="'.$filelink.'" />';
 				}
 				if ($output ne '') {
+					   $message='';
 					   if ($target ne 'tex') {
 						   $message.='<p>'.$output.'</p>';
 					   } else {
@@ -409,11 +514,11 @@
 			}
 			if ($allowed) {
 				 &Apache::lonfeedback::newline_to_br(\$urls);
-				 &Apache::lontemplate::print_start_template($r,$fields{$field}.
+				 &Apache::lontemplate::print_start_template($r,$title.
 						  &Apache::loncommon::help_open_topic('Syllabus_URLs'),'LC_Box');
 				 $r->print($urls);
 				 $r->print("<br /><div>");
-				 &Apache::lontemplate::print_textarea_template($r, $data{$field},
+				 &Apache::lontemplate::print_textarea_template($r, $message,
 					$field, Apache::lontemplate->RICH_TEXT_ALWAYS_OFF);
 				 &Apache::lontemplate::print_saveall_template($r);                         
 				 $r->print("</div>");
@@ -423,9 +528,9 @@
 				$r->print($message);
 			}
 		};
-		my %custom_hash = ( 'lll_includeurl' => $url_include_handler );
-		@htmlids = &Apache::lontemplate::print_template_fields($r, \%syllabus, \%syllabusfields, 
-			$target, $allowed, Apache::lontemplate->RICH_TEXT_DETECT_HTML, \%custom_hash);
+		my %custom_hash = ( TYPE_URL_INCLUDE() => $url_include_handler );
+ 		@htmlids = &print_template_new_fields($r, \%data, 
+ 			$target, $allowed, Apache::lontemplate->RICH_TEXT_DETECT_HTML, \%custom_hash);
         if ($allowed) {
             $r->print('</form>'.
             &Apache::lonhtmlcommon::htmlareaselectactive(@htmlids));
@@ -448,5 +553,112 @@
     return OK;
 }
 
+sub print_template_new_fields {
+	my ($r, $data_ref, $target, $allowed, $default_rich_text, $custom_handlers_ref, $group) = @_;
+	my @html_ids = ();
+	my %data = %{$data_ref};
+	my @fields = @{thaw($data{'data.fields'})};
+	my %custom_handlers = %{$custom_handlers_ref};
+
+	foreach my $key (@fields) {
+		my %field = %{thaw($data{'data.field.'.$key})};
+		my $title = $field{title};
+		my $raw_message = $field{content};
+		my $type = $field{type};
+		my $message = $raw_message if (($raw_message=~/\w/) || ($allowed));
+		if ((%custom_handlers) && exists($custom_handlers{$type})) {
+			#$custom_handlers{$type}->($r, $field, $json_ref, $group, $target, $allowed);
+		} else {
+			if (($raw_message=~/\w/) || ($allowed)) {
+				if (!&Apache::lonfeedback::contains_block_html($message)) {
+					&Apache::lonfeedback::newline_to_br(\$message);
+				} else {
+					$message = &Apache::lonfeedback::tidy_html($message);
+				}
+				$message=&Apache::lonhtmlcommon::raw_href_to_link($message);
+				if ($allowed) {
+					$message=&Apache::lonspeller::markeduptext($message);
+				}
+				$message=&Apache::lontexconvert::msgtexconverted($message);
+				if ($target ne 'tex') {
+					#output of syllabusfields will be generated here. 
+					&Apache::lontemplate::print_start_template($r,$title,'LC_Box');
+					$r->print($message);
+					if ($allowed) {
+						$r->print("<br /><div>");
+						&Apache::lontemplate::print_textarea_template($r, $raw_message,
+							$key, $default_rich_text);
+						&Apache::lontemplate::print_saveall_template($r);
+						if (!exists($data{'properties.v2_converted'})) {
+							$r->print("<a href='?delete=$key&forceedit=1'>Delete</a>");
+						}
+						$r->print("</div>");
+					} 
+					&Apache::lontemplate::print_end_template($r);
+				} else {
+				    my $safeinit;
+                    $r->print(&Apache::lonxml::xmlparse($r,'tex','<h3>'.$title.'</h3>'));
+                    $r->print(&Apache::lonxml::xmlparse($r,'tex',$message));
+				}
+				push(@html_ids,"hello");
+			}
+		}
+	}
+	
+	return @html_ids;	
+}
+
+sub convert_from_v2 {
+	my ($r, $data_ref, $fields_ref, $conflict) = @_;
+	my %data = %{$data_ref};
+	my %fields = %{$fields_ref};
+	my @fields_order = (!$conflict) ? () : @{thaw($data{'data.fields'})};
+	my %old_new_map = (!$conflict) ? () : %{thaw($data{'data.old_new_map'})};
+	my $repeat_int = 0;  #ensure fields with created timestamp are unique
+	foreach my $element (sort(keys(%fields))) {
+		my %new_element = ();
+		my $title = $fields{$element};
+		my $title_hash = time."_".$$;
+		if (exists($data{'data.field.'.$title_hash})) {
+			$title_hash .= "_".$repeat_int++;
+		}
+		my $content = $data{$element};
+		$new_element{title} = $title;
+		$new_element{content} = $content;
+		if ($element eq 'lll_includeurl') {
+			$new_element{type} = TYPE_URL_INCLUDE;
+		} else {
+			$new_element{type} = TYPE_TEXT_HTML;
+		}
+		if (!$conflict) {
+			$r->print("Creating new field with ID: ".$title_hash."<br />");
+			$data{'data.field.'.$title_hash} = freeze(\%new_element);
+			$old_new_map{$element} = $title_hash;
+			push(@fields_order, $title_hash);
+		} else {
+			if (exists($old_new_map{$element})) {
+				$r->print("Transferring old field ".$element." to new ID: ".$old_new_map{$element}."<br />");
+				if (exists($data{'data.field.'.$old_new_map{$element}})) {
+					my %new_field = %{thaw($data{'data.field.'.$old_new_map{$element}})};
+					$new_field{content} = $content;
+					$data{'data.field.'.$old_new_map{$element}} = freeze(\%new_field);
+				}
+			} else {
+				$data{'data.field.'.$title_hash} = freeze(\%new_element);
+				$old_new_map{$element} = $title_hash;
+				$data{'properties.v2_conflict_fail'} = 1;
+				push(@fields_order, $title_hash);
+			}
+		}
+	}
+	$data{'data.fields'} = freeze(\@fields_order);
+	$data{'data.old_new_map'} = freeze(\%old_new_map);
+	$data{'properties.last_modified'} = time;
+	$data{'properties.v2_converted'} = 1;
+	$data{'properties.type'} = 'syllabus';
+	
+	return \%data;
+}
+
 1;
 __END__

--faziophi1266211860--