--- loncom/interface/lonannounce.pm 2006/04/22 16:32:55 1.49 +++ loncom/interface/lonannounce.pm 2008/10/14 13:52:23 1.74 @@ -1,7 +1,7 @@ # The LearningOnline Network # Announce # -# $Id: lonannounce.pm,v 1.49 2006/04/22 16:32:55 albertel Exp $ +# $Id: lonannounce.pm,v 1.74 2008/10/14 13:52:23 amueller Exp $ # # Copyright Michigan State University Board of Trustees # @@ -37,6 +37,9 @@ use Apache::lonnavmaps(); use Apache::lonrss(); use Apache::lonnet; use HTML::Entities(); +use LONCAPA qw(:match); +use DateTime; +use DateTime::TimeZone; my %todayhash; my %showedcheck; @@ -50,14 +53,17 @@ sub editfield { my $enddateform = &Apache::lonhtmlcommon::date_setter('anno', 'enddate', $end); - my $help=&Apache::loncommon::help_open_menu('','Calendar Add Announcement','Calendar_Add_Announcement','',274,'Communication Tools'); - my %lt=&Apache::lonlocal::texthash('post' => 'Post Announcement', + #my $help=&Apache::loncommon::help_open_menu('Calendar Add Announcement','Calendar_Add_Announcement',274,'Communication Tools'); + my $help=&Apache::loncommon::help_open_topic('Calendar_Add_Announcement'); + + my %lt=&Apache::lonlocal::texthash('annon' => 'Course Announcements', + 'post' => 'Post Announcement', 'start' => 'Starting date', 'end' => 'Ending date', 'incrss' => 'Include in course RSS newsfeed'); $r->print(<$lt{'annon'} $help
@@ -73,82 +79,116 @@ sub readcalendar { my $courseid=shift; my $coursenum=$env{'course.'.$courseid.'.num'}; my $coursedom=$env{'course.'.$courseid.'.domain'}; + if ($coursenum eq '' || $coursedom eq '') { + my %courseinfo=&Apache::lonnet::coursedescription($courseid); + if ($coursenum eq '' && exists($courseinfo{'num'})) { + $coursenum = $courseinfo{'num'}; + } + if ($coursedom eq '' && exists($courseinfo{'domain'})) { + $coursedom = $courseinfo{'domain'}; + } + } + my %thiscal=&Apache::lonnet::dump('calendar',$coursedom,$coursenum); my %returnhash=(); foreach my $item (keys(%thiscal)) { unless (($item=~/^error\:/) || ($thiscal{$item}=~/^error\:/)) { - $returnhash{$courseid.'@'.$item}=$thiscal{$item}; + my ($start,$end)=split('_',$item); + $returnhash{join("\0",$courseid,$start,$end)}=$thiscal{$item}; } } - + my $can_see_hidden = ($env{'request.role.adv'} && + ($courseid eq $env{'request.course.id'})); + + my $navmap; if ($courseid eq $env{'request.course.id'}) { - my $can_see_hidden = $env{'request.role.adv'}; - my $navmap = Apache::lonnavmaps::navmap->new(); - my %resourcedata= - &Apache::lonnet::dump('resourcedata',$coursedom,$coursenum); - foreach my $thiskey (sort keys %resourcedata) { - if ($resourcedata{$thiskey.'.type'}=~/^date/) { - my ($course,$middle,$part,$name)= - ($thiskey=~/^(\w+)\.(?:(.+)\.)*([\w\s]+)\.(\w+)$/); - my $section=&mt('All Students'); - if ($middle=~/^\[(.*)\]\./) { - my $sec=$1; - # if we have a section don't show ones that aren't ours - if ($env{'request.course.sec'} && - $env{'request.course.sec'} ne $sec) { next; } - # if a student without a section don't show any section ones - if (!$env{'request.role.adv'} && - !$env{'request.course.sec'}) { next; } - $section=&mt('Group/Section').': '.$1; - $middle=~s/^\[(.*)\]\.//; + $navmap = Apache::lonnavmaps::navmap->new(); + } + + my $resourcedata= + &Apache::lonnet::get_courseresdata($coursenum,$coursedom); + if (ref($resourcedata) ne 'HASH') { + return %returnhash; + } + foreach my $thiskey (keys(%$resourcedata)) { + if ($resourcedata->{$thiskey.'.type'}=~/^date/) { + my ($course,$middle,$part,$name)= + ($thiskey=~/^(\Q$courseid\E)\.(?:(.+)\.)*([\w\s]+)\.(\w+)$/); + + my %data = ( 'section' => &mt('All Students')); + if ($middle=~/^\[(.*)\]\./) { + my $sec=$1; + # if we have a section don't show ones that aren't ours + if ($env{'request.course.sec'} && + $env{'request.course.sec'} ne $sec) { next; } + # if a student without a section don't show any section ones + if (!$env{'request.role.adv'} && + !$env{'request.course.sec'}) { next; } + $data{'section'}=&mt('Group/Section').': '.$1; + $middle=~s/^\[(.*)\]\.//; + } + $middle=~s/\.$//; + $data{'realm'}=&mt('All Resources'); + if ($middle eq '___(all)') { + if (!$can_see_hidden && !$navmap) { + next; + } + } elsif ($middle=~/^(.+)\_\_\_\(all\)$/) { + my $map_url=$1; + if (!$can_see_hidden && !$navmap) { + next; } - $middle=~s/\.$//; - my $realm=&mt('All Resources'); - if ($middle=~/^(.+)\_\_\_\(all\)$/) { - my $map_url=$1; - if (!$can_see_hidden && !$navmap) { + if (!$can_see_hidden) { + my $res = $navmap->getResourceByUrl($map_url); + if ($res && $res->randomout()) { next; } - if (!$can_see_hidden) { - my $res = $navmap->getResourceByUrl($map_url); - if ($res && $res->randomout()) { next; } - } - $realm=&mt('Folder/Map').': '.&Apache::lonnet::gettitle($map_url); - } elsif ($middle) { - if (!$can_see_hidden && !$navmap) { + } + $data{'realm'}=&mt('Folder/Map'); + $data{'url'} = $map_url; + } elsif ($middle) { + if (!$can_see_hidden && !$navmap) { + next; + } + if (!$can_see_hidden) { + my $res = $navmap->getBySymb($middle); + if ($res && $res->randomout()) { next; } - if (!$can_see_hidden) { - my $res = $navmap->getBySymb($middle); - if ($res && $res->randomout()) { next; } - } - $realm=&mt('Resource').': '.&Apache::lonnet::gettitle($middle); } - my $datetype=''; - if ($name eq 'duedate') { - $datetype=&mt('Due'); + $data{'realm'} = &mt('Resource'); + $data{'symb'} = $middle; + } + $data{'datetype'} = $name; + if ($name eq 'duedate') { + $data{'datetype'} = &mt('Due'); # see if accidentally answerdate is before duedate - my $answerkey=$thiskey; - $answerkey=~s/duedate$/answerdate/; - if ($resourcedata{$thiskey}>$resourcedata{$answerkey}) { - $datetype='Due and Answer Available'; - } + my $answerkey=$thiskey; + $answerkey=~s/duedate$/answerdate/; + if ($resourcedata->{$thiskey}>$resourcedata->{$answerkey}) { + $data{'datetype'} = &mt('Due and Answer Available'); } - if ($name eq 'opendate') { $datetype=&mt('Opening'); } - if ($name eq 'answerdate') { + } + if ($name eq 'opendate' + || $name eq 'contentopen' ) { + $data{'datetype'}=&mt('Opening'); + } + if ($name eq 'contentclose') { + $data{'datetype'}=&mt('Closing'); + } + if ($name eq 'answerdate') { # see if accidentally answerdate is before duedate - my $duekey=$thiskey; - $duekey=~s/answerdate$/duedate/; - if ($resourcedata{$duekey}>$resourcedata{$thiskey}) { + my $duekey=$thiskey; + $duekey=~s/answerdate$/duedate/; + if ($resourcedata->{$duekey}>$resourcedata->{$thiskey}) { # forget it - next; - } - $datetype=&mt('Answer Available'); - } - $returnhash{$courseid.'@'.$resourcedata{$thiskey}.'_'. - $resourcedata{$thiskey}}= - 'INTERNAL:'.$datetype.': '.$realm.' ('.$section.')'; + next; + } + $data{'datetype'}=&mt('Answer Available'); } + $returnhash{join("\0",$courseid, + $resourcedata->{$thiskey}, + $resourcedata->{$thiskey})}=\%data; } } return %returnhash; @@ -159,23 +199,25 @@ sub emptycell { } sub normalcell { - my ($day,$month,$year,$text)=@_; - my $output=''; - my @items=&order($text); + my ($day,$month,$year,$items_ref)=@_; + my $output; + my @items=&order($items_ref); foreach my $item (@items) { if ($item) { - my $internalflag=0; - my ($courseid,$start,$end,$msg)=split(/\@/,$item,4); - if ($msg=~/INTERNAL\:/) { - $msg=~s/INTERNAL\://gs; - $internalflag=1; - } + my ($courseid,$start,$end,$msg)=@$item; + my $internalflag= (ref($msg)) ? 1 : 0; + $msg = &display_msg($msg); my $fullmsg=&mt('Calendar Announcement for ').$env{'course.'.$courseid.'.description'}. '\n'.&Apache::lonlocal::locallocaltime($start); if ($start!=$end) { $fullmsg.=' - '.&Apache::lonlocal::locallocaltime($end); } $fullmsg.=':\n'.$msg; + $fullmsg=~s/[\n\r]/\\n/gs; + $fullmsg=&HTML::Entities::encode($fullmsg,'<>&"\''); + $fullmsg=~s/&/\\&/g; + my $short_msg = substr($msg,0,20).((length($msg) > 20)?'...':''); + if (defined($output)) { $output.='
'; } if ($courseid eq $env{'request.course.id'}) { if ((&Apache::lonnet::allowed('srm',$env{'request.course.id'})) && (!$showedcheck{$start.'_'.$end}) @@ -186,11 +228,8 @@ sub normalcell { $showedcheck{$start.'_'.$end}=1; } } - $fullmsg=~s/[\n\r]/\\n/gs; - $fullmsg=&HTML::Entities::encode($fullmsg,'<>&"\''); - $fullmsg=~s/&/\\&/g; $output.=''. - substr($msg,0,20).'...
'; + $short_msg.''; } } return '
$lt{'start'}:$startdateform
80)?'...':''); + if (defined($output)) { $output.='
'; } $output.=''. - substr($msg,0,80).'...
'; + $short_msg.''; } } return $output; } sub listcell { - my ($text)=@_; + my ($items_ref)=@_; my $output=''; - my @items=&order($text); + my @items=&order($items_ref); foreach my $item (@items) { - if ($item) { - my ($courseid,$start,$end,$msg)=split(/\@/,$item,4); - $msg=~s/INTERNAL\://gs; - my $fullmsg=&Apache::lonlocal::locallocaltime($start); + if (ref($item)) { + my ($courseid,$start,$end,$msg)=@$item; + my $fullmsg=&Apache::lonlocal::locallocaltime($start); if ($start!=$end) { $fullmsg.=&mt(' to '). &Apache::lonlocal::locallocaltime($end); } - $fullmsg.=':
'. - $msg.''; + $fullmsg.=':
'.&display_msg($msg).''; $output.='
  • '.$fullmsg.'
    • '; } } @@ -246,49 +285,118 @@ sub listcell { } sub order { - my ($text)=@_; - my @items = split(/___&&&___/,$text); - sort { - my (undef,$astart,$aend)=split(/\@/,$a); - my (undef,$bstart,$bend)=split(/\@/,$b); + my ($items)=@_; + return sort { + my ($astart,$aend)=$a->[1,2]; + my ($bstart,$bend)=$b->[1,2]; if ($astart != $bstart) { return $astart <=> $bstart; } return $aend <=> $bend; - } @items; + } @$items; } sub nextday { - my %th=@_; - $th{'day'}++; + my ($tk,%th)=@_; + my ($incmonth,$incyear); + if ($th{'day'} > 27) { + if ($th{'month'} == 2) { + if ($th{'day'} == 29) { + $incmonth = 1; + } elsif ($th{'day'} == 28) { + if (!&is_leap_year($tk)) { + $incmonth = 1; + } + } + } elsif (($th{'month'} == 4) || ($th{'month'} == 6) || + ($th{'month'} == 9) || ($th{'month'} == 11)) { + if ($th{'day'} == 30) { + $incmonth = 1; + } + } elsif ($th{'day'} == 31) { + if ($th{'month'} == 12) { + $incyear = 1; + } else { + $incmonth = 1; + } + } + if ($incyear) { + $th{'day'} = 1; + $th{'month'} = 1; + $th{'year'}++; + } elsif ($incmonth) { + $th{'day'} = 1; + $th{'month'}++; + } else { + $th{'day'}++; + } + } else { + $th{'day'}++; + } return (&Apache::loncommon::maketime(%th),$th{'month'}); } +sub is_leap_year { + my ($thistime) = @_; + my ($is_leap,$timezone,$dt); + $timezone = &Apache::lonlocal::gettimezone(); + eval { + $dt = DateTime->from_epoch(epoch => $thistime) + ->set_time_zone($timezone); + }; + if (!$@) { + $is_leap = $dt->is_leap_year; + } + return $is_leap; +} + +sub display_msg { + my ($msg) = @_; + + # if it's not a ref, it's an instructor provided message + return $msg if (!ref($msg)); + + my $output = $msg->{'datetype'}. ': '.$msg->{'realm'}; + if (exists($msg->{'url'})) { + my $displayurl=&Apache::lonnet::gettitle($msg->{'url'}); + if ($msg->{'url'}!~/\Q$displayurl\E$/) { + $output .= ' - '.$displayurl; + } + } + if (exists($msg->{'symb'})) { + my $displaysymb=&Apache::lonnet::gettitle($msg->{'symb'}); + if ($msg->{'symb'}!~/\Q$displaysymb\E$/) { + $output .= ' - '.$displaysymb; + } + } + $output .= ' ('.$msg->{'section'}.') '; + return $output; +} + sub showday { my ($tk,$mode,%allcal)=@_; my %th=&Apache::loncommon::timehash($tk); - my ($nextday,$nextmonth)=&nextday(%th); - my $outp=''; + my ($nextday,$nextmonth)=&nextday($tk,%th); + my @outp; if ($mode) { my $oneday=24*3600; $tk-=$oneday; $nextday+=$oneday; } foreach my $item (keys(%allcal)) { - my ($course,$startdate,$enddate)=($item=~/^(\w+)\@(\d+)\_(\d+)$/); - if (($startdate<$nextday) && ($enddate>=$tk)) { - $outp.='___&&&___'.$course.'@'.$startdate.'@'.$enddate.'@'. - $allcal{$item}; + my ($courseid,$startdate,$enddate)= split("\0",$item); + if (($startdate<$nextday) && ($enddate>=$tk)) { + push(@outp,[$courseid,$startdate,$enddate,$allcal{$item}]); } } unless ($mode) { return ($nextday,$nextmonth,&normalcell( - $th{'day'},$th{'month'},$th{'year'},$outp)); - } elsif ($outp) { + $th{'day'},$th{'month'},$th{'year'},\@outp)); + } elsif (@outp) { if ($mode==1) { - return '
    '.&plaincell($outp); + return '
    '.&plaincell(\@outp); } else { - return '
      '.&listcell($outp).'
    '; + return '
      '.&listcell(\@outp).'
    '; } } else { return ''; @@ -322,9 +430,58 @@ function dialin(day,month,year) { ENDDIA } +# ----------------------------------------------------- Summarize all calendars +sub get_all_calendars { + my %allcal=(); + my %courses = &Apache::loncommon::findallcourses(); + foreach my $course (sort(keys(%courses))) { + %allcal=(%allcal,&readcalendar($course)); + } + return %allcal; +} + +sub output_ics_file { + my ($r)=@_; +# RFC 2445 wants CRLF + my $crlf="\015\012"; +# Header + $r->print("BEGIN:VCALENDAR$crlf"); + $r->print("VERSION:2.0$crlf"); + $r->print("PRODID:-//LONCAPA//LONCAPA Calendar Output//EN$crlf"); + my %allcal=&get_all_calendars(); + foreach my $event (keys(%allcal)) { + my ($courseid,$startdate,$enddate)= split('\0',$event); + my $uid=$event; + $uid=~s/[\W\_]/-/gs; + $uid.='@loncapa'; + my $summary=&display_msg($allcal{$event}); + $summary=~s/\s+/ /gs; + $summary=$env{'course.'.$courseid.'.description'}.': '.$summary; + $r->print("BEGIN:VEVENT$crlf"); + $r->print("DTSTART:".&Apache::loncommon::utc_string($startdate).$crlf); + $r->print("DTEND:".&Apache::loncommon::utc_string($enddate).$crlf); + $r->print("SUMMARY:$summary$crlf"); + $r->print("UID:$uid$crlf"); + $r->print("END:VEVENT$crlf"); + } +# Footer + $r->print("END:VCALENDAR$crlf"); +} + +sub show_timezone { + my $tzone = &Apache::lonlocal::gettimezone(); + my $dt = DateTime->now(); + my $tz = DateTime::TimeZone->new( name => $tzone ); + return &mt('([_1] time zone)',$tz->short_name_for_datetime($dt)); +} sub handler { my $r = shift; + if ($r->uri=~/\.(ics|ical)$/) { + &Apache::loncommon::content_type($r,'text/calendar'); + &output_ics_file($r); + return OK; + } &Apache::loncommon::content_type($r,'text/html'); $r->send_http_header; return OK if $r->header_only; @@ -349,12 +506,15 @@ sub handler { '&element='.$env{'form.element'}; # --------------------------------------------- Find out first day of the month - my %firstday=&Apache::loncommon::timehash( - &Apache::loncommon::maketime( 'day' => 1, 'month'=> $month, - 'year' => $year, 'hours' => 0, - 'minutes' => 0, 'seconds' => 0, - 'dlsav' => -1 )); + my $tk = &Apache::loncommon::maketime( 'day' => 1, + 'month'=> $month, + 'year' => $year, + 'hour' => 0, + 'minute' => 0, + 'second' => 0); + my %firstday = &Apache::loncommon::timehash($tk); my $weekday=$firstday{'weekday'}; + # ------------------------------------------------------------ Print the screen my $js = < @@ -410,25 +570,27 @@ ENDDOCUMENT } } } - $r->print(< -

    Post Server Announcements

    -Post announcements to the system login and roles screen
    -(leave blank to delete announcement)
    -
    -Check machines:
    -SERVERANNOUNCE + $r->print('' + .'

    '.&mt('Post Server Announcements').'

    ' + .&mt('Post announcements to the system login and roles screen').'
    ' + .''.&mt('(leave blank to delete announcement)').'
    ' + .'
    ' + .&mt('Check machines:').'
    ' + ); # list servers - foreach my $host (sort(keys(%Apache::lonnet::hostname))) { - if (&Apache::lonnet::allowed('psa',$Apache::lonnet::hostdom{$host})) { - $r->print ('
    '. - $host.' '.$Apache::lonnet::hostname{$host}.' '. - 'current'); + my %hostname = &Apache::lonnet::all_hostnames(); + foreach my $host (sort(keys(%hostname))) { + if (&Apache::lonnet::allowed('psa', + &Apache::lonnet::host_domain($host))) { + $r->print (''. + &mt('Current Announcement').'
    '); } } $r->print( - '
    '); + '
    '); } if ($allowed) { my $coursenum=$env{'course.'.$env{'request.course.id'}.'.num'}; @@ -475,28 +637,27 @@ SERVERANNOUNCE &editfield($r,$today,$tomorrow,''); } # ----------------------------------------------------- Summarize all calendars - my %allcal=(); - foreach my $course (sort(&Apache::loncommon::findallcourses())) { - %allcal=(%allcal,&readcalendar($course)); - } - + my %allcal=&get_all_calendars(); # ------------------------------- Initialize table and forward backward buttons my ($pm,$py,$fm,$fy)=($month-1,$year,$month+1,$year); if ($pm<1) { ($pm,$py)=(12,$year-1); } if ($fm>12){ ($fm,$fy)=(1,$year+1); } - $r->print('

    '.('',&mt('January'),&mt('February'),&mt('March'), + $r->print('

    '.&mt('Calendar').'

    ' + .'

    '.('',&mt('January'),&mt('February'),&mt('March'), &mt('April'),&mt('May'), &mt('June'),&mt('July'),&mt('August'), &mt('September'),&mt('October'), &mt('November'),&mt('December'))[$month].' '. - $year.'

    '); + $year.' '.&show_timezone().''); # Reached the end of times, give up if (($year<1970) || ($year>2037)) { - $r->print('

    No calendar available for this date.

    '. - 'Current Month'. - &Apache::loncommon::end_page()); + $r->print('

    ' + .&mt('No calendar available for this date.') + .'

    ' + .''.&mt('Current Month').'' + .&Apache::loncommon::end_page()); return OK; } @@ -504,6 +665,35 @@ SERVERANNOUNCE if ($env{'form.pickdate'} eq 'yes') { $class .= " LC_calendar_pickdate"; } +# ------------------------------------------------ Determine first day of a week + my $datelocale = &Apache::lonlocal::getdatelocale(); + my $days_in_week = 7; + my $startweek = 0; + if (ref($datelocale)) { + $startweek = $datelocale->first_day_of_week(); + if ($startweek == $days_in_week) { $startweek = 0; } + } + my @days = ('Sun','Mon','Tue','Wed','Thu','Fri','Sat'); + my @localdays; + if ($startweek == 0) { + @localdays = @days; + } else { + my $endday = $days_in_week - $startweek; + for (my $i=0; $i<$days_in_week; $i++) { + if ($i < $endday) { + $localdays[$i] = $days[$i+$startweek]; + } else { + $localdays[$i] = $days[$i-$endday]; + } + } + } + +# ----------------------------------------------------------- Weekday in locale + my $loc_weekday = $weekday - $startweek; + if ($loc_weekday < 0) { + $loc_weekday += $days_in_week; + } + $r->print( ''.&mt('Previous Month').' '. @@ -512,43 +702,51 @@ SERVERANNOUNCE '   '.&mt('Current Month').'

    '. - ' - - - - - - -'); + '
    '.&mt('Sun').''.&mt('Mon').''.&mt('Tue').''.&mt('Wed').''.&mt('Thu').''.&mt('Fri').''.&mt('Sat').'
    '); + for (my $i=0; $i<@localdays; $i++) { + $r->print(''); + } + $r->print(''); - my $tk=&Apache::loncommon::maketime(%firstday); my $outp; my $nm; # ---------------------------------------------------------------- Actual table $r->print(''); - for (my $i=0;$i<$weekday;$i++) { $r->print(&emptycell); } - for (my $i=$weekday;$i<=6;$i++) { + for (my $i=0;$i<$loc_weekday;$i++) { $r->print(&emptycell); } + for (my $i=$loc_weekday;$i<=6;$i++) { ($tk,$nm,$outp)=&showday($tk,0,%allcal); $r->print($outp); } $r->print(''); + my $lastrow = 0; + my $lastday = 0; for (my $k=0;$k<=4;$k++) { - $r->print(''); - for (my $i=0;$i<=6;$i++) { - ($tk,$nm,$outp)=&showday($tk,0,%allcal); - if ($month!=$nm) { $outp=&emptycell; } - $r->print($outp); + if (!$lastrow) { + $r->print(''); + for (my $i=0;$i<=6;$i++) { + if ($lastday) { + $outp = &emptycell(); + } else { + my $currtk = $tk; + ($tk,$nm,$outp)=&showday($tk,0,%allcal); + if ($month!=$nm) { $lastday = 1; } + } + $r->print($outp); + } + if ($lastday) { + $lastrow = 1; + } + $r->print(''); } - $r->print(''); } # ------------------------------------------------------------------- End table $r->print('
    '.&mt($localdays[$i]).'
    '); # ----------------------------------------------------------------- Check marks undef(%showedcheck); # --------------------------------------------------------------- Remove button - if ($allowed) { $r->print(''. + if ($allowed) { $r->print('
    '. &Apache::loncommon::help_open_topic('Calendar_Remove_Announcement').''); } $r->print('

    '. ''.&mt('Current Month').'

    '. ($pickdatemode?'':'').&Apache::loncommon::end_page()); + $r->print(''.&mt('Download your Calendar as iCalendar File').''); return OK; }