File:
[LON-CAPA] /
loncom /
interface /
lonsimplepage.pm
Revision
1.93:
download - view:
text,
annotated -
select for diffs
Sun Jan 31 06:03:55 2010 UTC (14 years, 5 months ago) by
faziophi
Branches:
MAIN
CVS tags:
version_2_9_99_0,
bz6209-base,
bz6209,
HEAD
Refactors nearly-common code located in the templated pages,
into a new routine &print_template_fields() which controls printing
LC_Boxes for fields, and <textarea>s as necessary. Custom fields
(links to be included, for example), are processed using handler routines
in closures, which are passed in a hash to the routine.
Saves about 140 lines of code are so?
1: # The LearningOnline Network
2: # Simple Page Editor
3: #
4: # $Id: lonsimplepage.pm,v 1.93 2010/01/31 06:03:55 faziophi Exp $
5: #
6: # Copyright Michigan State University Board of Trustees
7: #
8: # This file is part of the LearningOnline Network with CAPA (LON-CAPA).
9: #
10: # LON-CAPA is free software; you can redistribute it and/or modify
11: # it under the terms of the GNU General Public License as published by
12: # the Free Software Foundation; either version 2 of the License, or
13: # (at your option) any later version.
14: #
15: # LON-CAPA is distributed in the hope that it will be useful,
16: # but WITHOUT ANY WARRANTY; without even the implied warranty of
17: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18: # GNU General Public License for more details.
19: #
20: # You should have received a copy of the GNU General Public License
21: # along with LON-CAPA; if not, write to the Free Software
22: # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
23: #
24: # /home/httpd/html/adm/gpl.txt
25: #
26: # http://www.lon-capa.org/
27: #
28:
29: package Apache::lonsimplepage;
30:
31: use strict;
32: use Apache::Constants qw(:common);
33: use Apache::loncommon;
34: use Apache::lontemplate;
35: use Apache::lonnet;
36: use Apache::lontexconvert;
37: use Apache::lonfeedback;
38: use Apache::lonlocal;
39: use Apache::lonprintout;
40: use Apache::lonxml;
41: use Apache::longroup;
42: use HTML::Entities();
43: use LONCAPA;
44:
45: sub get_db_name {
46: my ($url) = @_;
47: my ($udom,$uname,$marker)=(split(m{/},$url))[2,3,4];
48: my $dom = $env{'course.'.$env{'request.course.id'}.'.domain'};
49: my $crs = $env{'course.'.$env{'request.course.id'}.'.num'};
50:
51: my $db_name;
52:
53: if ($dom && $crs && ($udom eq $dom) && ($uname eq $crs)) {
54: $marker =~ s/\W//g;
55: $db_name = 'grppage_'.$marker;
56: } else {
57: $marker=~s/\D//g;
58: $db_name = 'smppage_'.$marker;
59: }
60: return if (!defined($marker));
61:
62: return $db_name;
63: }
64:
65: sub handler {
66: my $r = shift;
67: &Apache::loncommon::content_type($r,'text/html');
68: $r->send_http_header;
69: return OK if $r->header_only;
70: my $target=$env{'form.grade_target'};
71: # ------------------------------------------------------------ Print the screen
72: if ($target eq 'tex') {
73: $r->print(&Apache::lonprintout::print_latex_header($env{'form.latex_type'}));
74: }
75:
76: # Is this even in a course?
77: unless ($env{'request.course.id'}) {
78: if ($target ne 'tex') {
79: &Apache::loncommon::simple_error_page($r,'','Not in a course');
80: } else {
81: $r->print('\textbf{Not in a course}\end{document}');
82: }
83: return OK;
84: }
85:
86: my $db_name = &get_db_name($r->uri);
87:
88: my $dom = $env{'course.'.$env{'request.course.id'}.'.domain'};
89: my $crs = $env{'course.'.$env{'request.course.id'}.'.num'};
90: my ($group,$group_desc,$group_home_view,$group_home_edit,
91: $group_view_perm,$group_edit_perm);
92: my %curr_group = ();
93: my %groupinfo = ();
94: if ($db_name =~ /^grppage_/) {
95: $group = (split(m{/},$r->uri))[4];
96: $group =~ s/\W//g;
97: my %curr_groups = &Apache::longroup::coursegroups($dom,$crs,$group);
98: if (!%curr_groups) {
99: &Apache::loncommon::simple_error_page($r,'','Invalid group name');
100: return OK;
101: }
102: %groupinfo =
103: &Apache::longroup::get_group_settings($curr_groups{$group});
104: $group_desc = &unescape($groupinfo{'description'});
105: }
106:
107: if (!$db_name) {
108: &Apache::loncommon::simple_error_page($r,'','Invalid call');
109: return OK;
110: }
111:
112: # --------------------------------------------------------- The syllabus fields
113: my %syllabusfields=&Apache::lonlocal::texthash(
114: 'aaa_title' => 'Page Title',
115: 'bbb_content' => 'Content',
116: 'ccc_webreferences' => 'Web References');
117: if ($group ne '') {
118: $syllabusfields{'abb_links'} = &mt('Available Group Tools');
119: }
120:
121:
122: # ------------------------------------------------------------ Get query string
123: &Apache::loncommon::get_unprocessed_cgi
124: ($ENV{'QUERY_STRING'},['forcestudent','forceedit',
125: 'register','ref']);
126: # --------------------------------------------------------------- Force Student
127: my $forcestudent='';
128: if ($env{'form.forcestudent'} || $target eq 'tex' ) { $forcestudent='student'; };
129: my $forceedit='';
130: if ($env{'form.forceedit'}) { $forceedit='edit'; }
131:
132: my $refarg;
133: if ($env{'form.ref'}) {
134: $refarg = '&ref='.$env{'form.ref'};
135: }
136:
137: my %syllabus=&Apache::lonnet::dump($db_name,$dom,$crs);
138:
139: # --------------------------------------- There is such a user, get environment
140:
141: if ($target ne 'tex') {
142: my $title = 'Simple Course Page';
143: if ($group ne '') {
144: $title = 'Simple Group Page';
145: }
146: my $start_page =
147: &Apache::loncommon::start_page($title,undef,
148: {'function' => $forcestudent,
149: 'domain' => $dom,
150: 'force_register' =>
151: $env{'form.register'},});
152: $r->print($start_page);
153: }
154:
155: if ($group ne '') {
156: my $group_view_perm =
157: &Apache::lonnet::allowed('vcg',$env{'request.course.id'}.
158: ($env{'request.course.sec'}?'/'.$env{'request.course.sec'}:''));
159: $group_edit_perm =
160: &Apache::lonnet::allowed('mdg',$env{'request.course.id'}.
161: ($env{'request.course.sec'}?'/'.$env{'request.course.sec'}:''));
162: $group_home_view = &Apache::lonnet::allowed('vgh',
163: $env{'request.course.id'}.'/'.$group);
164: $group_home_edit = &Apache::lonnet::allowed('mgh',
165: $env{'request.course.id'}.'/'.$group);
166: if ($group_view_perm || $group_edit_perm || $group_home_view ||
167: $group_home_edit || &Apache::longroup::check_group_access($group)) {
168: if (($env{'form.ref'} eq 'grouplist') && ($target ne 'tex')) {
169: $r->print(&grouppage_breadcrumbs($dom,$crs,$group,$group_desc));
170: }
171: if ((!$group_home_edit) && (!$group_home_view) &&
172: (!$group_view_perm) && (!$group_edit_perm)) {
173: &display_group_links($r,$target,$group,'view',$refarg,%groupinfo);
174: if ($env{'form.grade_target'} ne 'tex') {
175: $r->print(&Apache::loncommon::end_page());
176: } else {
177: $r->print('\end{document}');
178: }
179: return OK;
180: }
181: } else {
182: my $msg =
183: &mt('You do not currently have rights to view this group.');
184: if ($target ne 'tex') {
185: $r->print('<p class="LC_warning">'.$msg.'</p>'.
186: &Apache::loncommon::end_page());
187: } else {
188: $r->print('\textbf{'.$msg.'}\end{document}');
189: }
190: return OK;
191: }
192: my ($blocked,$blocktext) =
193: &Apache::loncommon::blocking_status('groups');
194: if ($blocked) {
195: $r->print($blocktext);
196: $r->print(&Apache::loncommon::end_page());
197: return OK;
198: }
199: }
200:
201: my $allowed;
202:
203: if ($group ne '') {
204: $allowed = $group_edit_perm;
205: if (!$allowed) {
206: $allowed = $group_home_edit;
207: }
208: } else {
209: $allowed=&Apache::lonnet::allowed('mdc',$env{'request.course.id'});
210: }
211: my $privileged=$allowed;
212: if (($syllabus{'uploaded.lastmodified'}) && (!$forceedit)) {
213: $forcestudent='student';
214: }
215:
216: if ($forcestudent or $target eq 'tex') { $allowed=0; }
217:
218: if (($env{'form.uploaddoc.filename'} and $target ne 'tex') &&
219: ($env{'form.storeupl'}) && ($allowed)) {
220: if ($env{'form.uploaddoc.filename'}=~/\.(gif|jpg|png|jpeg)$/i) {
221: if ($syllabus{'uploaded.photourl'}) {
222: &Apache::lonnet::removeuploadedurl($syllabus{'uploaded.photourl'});
223: }
224: if ($group ne '') {
225: $syllabus{'uploaded.photourl'}=&Apache::lonnet::userfileupload(
226: 'uploaddoc',1,"grouppage/$group");
227: } else {
228: $syllabus{'uploaded.photourl'}=
229: &Apache::lonnet::userfileupload('uploaddoc',1,'simplepage');
230: }
231: }
232: $syllabus{'uploaded.lastmodified'}=time;
233: &Apache::lonnet::put($db_name,\%syllabus,$dom,$crs);
234: }
235: # if ($allowed && $env{'form.delupl'}) {
236: # if ($syllabus{'uploaded.photourl'}) {
237: # &Apache::lonnet::removeuploadedurl($syllabus{'uploaded.photourl'});
238: # delete($syllabus{'uploaded.photourl'});
239: # &Apache::lonnet::del('simplepage',['uploaded.photourl']);
240: # }
241: # }
242: if (($allowed) && ($env{'form.storesyl'})) {
243: foreach my $syl_field (keys(%syllabusfields)) {
244: my $field=$env{'form.'.$syl_field};
245: chomp($field);
246: $field=~s/\s+$//s;
247: $field=~s/^\s+//s;
248: $field=~s/\<br\s*\/*\>$//s;
249: $field=&Apache::lonfeedback::clear_out_html($field,1);
250: $syllabus{$syl_field}=$field;
251: }
252: $syllabus{'uploaded.lastmodified'}=time;
253: &Apache::lonnet::put($db_name,\%syllabus,$dom,$crs);
254: }
255:
256: #---Print Function
257: if ($target ne 'tex') {
258: if ($allowed || $privileged) {
259: my $functions=&Apache::lonhtmlcommon::start_funclist();
260: if ($allowed) {
261: $functions.=&Apache::lonhtmlcommon::add_item_funclist(
262: '<a href="'.$r->uri.'?forcestudent=1">'
263: .&mt('Show Student View').'</a>'
264: .&Apache::loncommon::help_open_topic(
265: 'Uploaded_Templates_PublicView'));
266: } elsif ($privileged) {
267: my $edittext = &mt('Edit');
268: if ($group ne '') {
269: $edittext = &mt('Edit Group Homepage');
270: }
271: $functions.=&Apache::lonhtmlcommon::add_item_funclist(
272: '<a href="'.$r->uri.'?forceedit=edit'.$refarg.'">'
273: .$edittext.'</a>');
274: if ($group ne '') {
275: if ($group_edit_perm) {
276: $functions.=&Apache::lonhtmlcommon::add_item_funclist(
277: '<a href="/adm/coursegroups'
278: .'?action=modify&refpage=grouplist'
279: .'&state=pick_task&groupname='
280: .$group.'">'
281: .&mt('Edit Group Settings')
282: .'</a>');
283: }
284: }
285: }
286: $functions.=&Apache::lonhtmlcommon::end_funclist();
287: $r->print(&Apache::loncommon::head_subbox($functions));
288: }
289: }
290:
291: #---Print help Text
292: if($target ne 'tex'){
293: if ($allowed) {
294: $r->print(&Apache::loncommon::help_open_topic('Uploaded_Templates_TextBoxes',&mt('Help with filling in text boxes')));
295: }
296: }
297:
298: # ---------------------------------------------------------------- Get syllabus
299: if ((($syllabus{'uploaded.lastmodified'}) &&
300: (($group ne '' && ($group_home_view || $group_edit_perm ||
301: $group_view_perm)) || ($group eq ''))) || ($allowed)) {
302: #Print the title
303: my $titletext=&HTML::Entities::encode($syllabus{'aaa_title'},'<>&"');
304: if ($target ne 'tex') {
305: if ($allowed) {
306: }
307: $r->print('<h2>'.$titletext.'</h2>');
308: } else {
309: my $safeinit;
310: $r->print(&Apache::lonxml::xmlparse($r,'tex','<h1>'.$titletext.'</h1>'));
311: }
312: if ($allowed) {
313: if ($env{'form.grade_target'} ne 'tex') {
314: #editbox for title
315: $r->print('<form method="post" action="" enctype="multipart/form-data">');
316: &Apache::lontemplate::print_start_template($r,&mt('Title'),'LC_Box');
317: $r->print($titletext);
318: $r->print("<br /><div>");
319: &Apache::lontemplate::print_textarea_template($r, $syllabus{'aaa_title'},
320: 'aaa_title', Apache::lontemplate->RICH_TEXT_ALWAYS_OFF);
321: &Apache::lontemplate::print_saveall_template($r);
322: $r->print("</div>");
323: &Apache::lontemplate::print_end_template($r);
324: } else {
325: my $safeinit;
326: $r->print(&Apache::lonxml::xmlparse($r,'tex',$syllabus{'aaa_title'},$safeinit));
327: }
328: }
329:
330: #print the image
331: my $image='';
332: if ($syllabus{'uploaded.photourl'}) {
333: &Apache::lonnet::allowuploaded('/adm/smppg',
334: $syllabus{'uploaded.photourl'});
335:
336: $image='<img src="'.$syllabus{'uploaded.photourl'}
337: .'" alt="'.&mt('Image').'" />';
338: if ($target eq 'tex') {
339: $image=&Apache::lonxml::xmlparse($r,'tex',$image);
340: }
341: }
342:
343: if ($allowed) {
344: &Apache::lontemplate::print_start_template($r, &mt('Upload a Photo'),'LC_Box');
345: $r->print($image);
346: $r->print("<br /><br />");
347: $r->print(
348: '<input type="hidden" name="forceedit" value="edit" />'.
349: '<input type="file" name="uploaddoc" size="50" />'.
350: '<input type="submit" name="storeupl" value="'.&mt('Upload').'" />'.
351: '<input type="hidden" name="forceedit" value="edit" />');
352: &Apache::lontemplate::print_end_template($r);
353:
354:
355: # if ($syllabus{'uploaded.photourl'}) {
356: # $r->print('<input type="submit" name="delupl"'
357: # .' value="'.&mt('Delete Photo').'" />');
358: # }
359: }
360: #Image in Student view and printout.
361: else {
362: $r->print($image);
363: }
364:
365: my $links_handler = sub {
366: my ($r, $field, $message, $group, $data_ref, $fields_ref, $target, $allowed) = @_;
367: if ($group ne '') {
368: my %data = %{$data_ref};
369: my %fields = %{$fields_ref};
370: $r->print('<br /><input type="hidden" name="'.$field.
371: '" value="'.$data{$field}.'" />');
372: &display_group_links($r, $target, $group, 'edit', $refarg, %groupinfo);
373: $r->print('<br />');
374: }
375: };
376: my $title_handler = sub {};
377: my %custom_handlers = (
378: 'abb_links' => $links_handler,
379: 'aaa_title' => $title_handler
380: );
381: &Apache::lontemplate::print_template_fields($r, \%syllabus, \%syllabusfields,
382: $target, $allowed, Apache::lontemplate->RICH_TEXT_DETECT_HTML, \%custom_handlers, $group);
383:
384: if ($allowed && ($env{'form.grade_target'} ne 'tex')) {
385: $r->print(&Apache::lonhtmlcommon::htmlareaselectactive
386: ('bbb_content').'</form>');
387: }
388:
389: } else {
390: if ($group ne '') {
391: &display_group_links($r,$target,$group,'view',$refarg,%groupinfo);
392: } else {
393: my $text=&mt('No page information provided.');
394: if ($target ne 'tex') {
395: $r->print('<p class="LC_info">'.$text.'</p>');
396: } else {
397: $r->print($text)
398: }
399: }
400: }
401: if ($env{'form.grade_target'} ne 'tex') {
402: $r->print(&Apache::loncommon::end_page());
403: } else {
404: $r->print('\end{document}');
405: }
406: return OK;
407: }
408:
409: sub display_group_links {
410: my ($r,$target,$group,$context,$refarg,%groupinfo) = @_;
411: my @available = ();
412: my %menu = ();
413: %{$menu{'email'}} = (
414: text => 'Group Message',
415: href => '/adm/email?compose=group&group='.$group.
416: $refarg,
417: );
418: %{$menu{'discussion'}} = (
419: text => 'Discussion Boards',
420: href => '/adm/groupboards?group='.$group.$refarg,
421: );
422: %{$menu{'chat'}} = (
423: text => 'Group Chat Room',
424: href => "javascript:group_chat('$group')",
425: );
426: %{$menu{'files'}} = (
427: text => 'Group Portfolio',
428: href => '/adm/coursegrp_portfolio?group='.$group.
429: $refarg,
430: );
431: %{$menu{'roster'}} = (
432: text => 'Membership Roster',
433: href => '/adm/grouproster?group='.$group.$refarg,
434: );
435: foreach my $tool (sort(keys(%menu))) {
436: if ($groupinfo{functions}{$tool} eq 'on') {
437: push(@available,$tool);
438: }
439: }
440: if (@available > 0) {
441: my $output = '';
442: if ($target eq 'tex') {
443: $output = '<table cellspacing="4" cellpadding="4">';
444: } else {
445: $output = &Apache::loncommon::start_data_table();
446: }
447: foreach my $tool (@available) {
448: if ($target eq 'tex') {
449: $output .= '<tr><td>'.&mt($menu{$tool}{text}).'</td></tr>';
450: } else {
451: $output .= &Apache::loncommon::start_data_table_row()
452: .'<td><a href="'.$menu{$tool}{href}.'">'
453: .&mt($menu{$tool}{text}).'</a></td>'
454: .&Apache::loncommon::end_data_table_row();
455: }
456: }
457: if ($target eq 'tex') {
458: $output .= '</table>';
459: } else {
460: $output .= &Apache::loncommon::end_data_table();
461: }
462: if ($target eq 'tex') {
463: $r->print(&Apache::lonxml::xmlparse($r,'tex',&mt('Available functions').'<br /><br />'.$output));
464: } else {
465: $r->print('<h3>'.&mt('Available Group Tools').'</h3>'.$output);
466: }
467: } else {
468: my $output;
469: if ($context eq 'edit') {
470: $output = &mt('No group functionality.');
471: } else {
472: $output = &mt('No group functionality (e.g., e-mail, discussion, chat room or file upload) is currently available to you in this group: [_1].','<b>'.&unescape($groupinfo{'description'}).'</b>');
473: }
474: if ($target eq 'tex') {
475: $r->print(&Apache::lonxml::xmlparse($r,'tex',$output));
476: } else {
477: $r->print($output);
478: }
479: }
480: }
481:
482: sub grouppage_breadcrumbs {
483: my ($cdom,$cnum,$group,$description) = @_;
484: &Apache::lonhtmlcommon::clear_breadcrumbs();
485: &Apache::lonhtmlcommon::add_breadcrumb
486: ({href=>"/adm/coursegroups",
487: text=>"Groups",
488: title=>"Display Groups"},
489: {href=>"/adm/$cdom/$cnum/$group/smppg?ref=grouplist",
490: text=>&mt('Group:')." $description",
491: title=>"Go to group's home page"},
492: );
493: my $output .= &Apache::lonhtmlcommon::breadcrumbs(&mt('Group page - [_1]',
494: $description));
495: return $output;
496: }
497:
498: 1;
499: __END__
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>