moodle/mod/data/fields.php

<?php  // $Id$
///////////////////////////////////////////////////////////////////////////
//                                                                       //
// NOTICE OF COPYRIGHT                                                   //
//                                                                       //
// Moodle - Modular Object-Oriented Dynamic Learning Environment         //
//          http://moodle.org                                            //
//                                                                       //
// Copyright (C) 2005 Martin Dougiamas  http://dougiamas.com             //
//                                                                       //
// This program 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.                                   //
//                                                                       //
// This program 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:                          //
//                                                                       //
//          http://www.gnu.org/copyleft/gpl.html                         //
//                                                                       //
///////////////////////////////////////////////////////////////////////////

    require_once('../../config.php');
    require_once('lib.php');
    require_once($CFG->libdir.'/blocklib.php');

    require_once('pagelib.php');
    require_login();
    
    $id    = optional_param('id', 0, PARAM_INT);    // course module id
    $d     = optional_param('d', 0, PARAM_INT);    // database id
    $fid   = optional_param('fid', 0 , PARAM_INT);    //update field id
    $newtype = optional_param('fieldmenu','',PARAM_ALPHA);    //type of the new field

    //action specifies what action is performed when data is submitted
    $mode = optional_param('mode','',PARAM_ALPHA);
    $displayflag = '';    //str to print after an operation,
    
    if ($id) {
        if (! $cm = get_record('course_modules', 'id', $id)) {
            error('Course Module ID was incorrect');
        }
        if (! $course = get_record('course', 'id', $cm->course)) {
            error('Course is misconfigured');
        }
        if (! $data = get_record('data', 'id', $cm->instance)) {
            error('Course module is incorrect');
        }

    } else {
        if (! $data = get_record('data', 'id', $d)) {
            error('Data ID is incorrect');
        }
        if (! $course = get_record('course', 'id', $data->course)) {
            error('Course is misconfigured');
        }
        if (! $cm = get_coursemodule_from_instance('data', $data->id, $course->id)) {
            error('Course Module ID was incorrect');
        }
    }

    if (!isteacheredit($course->id)){
        error(get_string('noaccess','data'));
    }

    $strdata = get_string('modulenameplural','data');

    print_header_simple($data->name, "", "<a href='index.php?id=$course->id'>$strdata</a> -> $data->name", "", "", true, "", navmenu($course));

    print_heading(format_string($data->name));
    
    
    /************************************
     *        Data Processing           *
     ***********************************/
    switch($mode){

        case 'add':    ///add a new field
            if (confirm_sesskey() and $field = data_submitted($CFG->wwwroot.'/mod/data/fields.php')){

                $sql = 'SELECT * from '.$CFG->prefix.'data_fields WHERE name LIKE "'.$field->name.
                       '" AND dataid = '.$data->id;
                
                if ($field->name and !get_record_sql($sql)){    
                    $field->dataid = $data->id;
                    
                    // Check for arrays. If we encounter an array, we save the array as a
                    // comma-delimited string in the database.
                    foreach ($field as $key=>$val) {
                        if (is_array($val)) {
                            $str = '';
                            foreach ($val as $inner) {
                                $str .= $inner . ',';
                            }
                            $str = substr($str, 0, -1);
                            
                            $field->$key = $str;
                        }
                    }
                    $field->id = insert_record('data_fields', $field);
                    
                    // Add the new field to the form templates.
                    data_append_field_in_form($field->dataid, $field->name);

                    add_to_log($course->id, 'data', 'fields add', "fields.php?d=$data->id&amp;mode=display&amp;fid=$field->id", $field->id, $cm->id);
                    
                    $displayflag = get_string('fieldadded','data');
                }
                else {    //no duplicate names allowed in one database!
                    $displayflag = get_string('invalidfieldname','data');
                }
            }
            break;

        case 'delete':    // Delete a field
            if (confirm_sesskey()){
                if ($confirm = optional_param('confirm', 0, PARAM_INT)) {
                    // Delete the associated data_contents and files.
                    if (!$fieldRecordSet = get_record('data_fields', 'id', $fid)) {
                        notify('Field not found');
                        exit;
                    }
                    $field = data_get_field($fieldRecordSet);
                    $field->delete_data_contents();
                    
                    // Update the templates.
                    data_replace_field_in_forms($fieldRecordSet->dataid, $fieldRecordSet->name, '');

                    // Delete the field.
                    delete_records('data_fields', 'id', $fid);

                    add_to_log($course->id, 'data', 'fields delete', "fields.php?d=$data->id", $data->id, $cm->id);
                    
                    $displayflag = get_string('fielddeleted', 'data');
                }
                else {
                    // Print confirmation message.
                    $field = get_record('data_fields','id',$fid);
                    print_simple_box_start('center', '60%');
                    echo '<div align="center">';
                    echo '<form action = "fields.php?d='.$data->id.'&amp;mode=delete&amp;fid='.$fid.'" method="post">';
                    echo '<input name="sesskey" value="'.sesskey().'" type="hidden" />';
                    echo '<input name="confirm" value="1" type="hidden" />';
                    echo '<strong>'.$field->name.'</strong> - '.get_string('confirmdeletefield','data');
                    echo '<p />';
                    echo '<input type="submit" value="'.get_string('ok').'" /> ';
                    echo '<input type="button" value="'.get_string('cancel').'" onclick="javascript:history.go(-1);" />';
                    echo '</form>';
                    echo '</div>';
                    print_simple_box_end();
                    echo '</td></tr></table>';
                    print_footer($course);
                    exit;
                }
            }
            break;

        case 'update':    ///update a field
            if (confirm_sesskey() and $field = data_submitted($CFG->wwwroot.'/mod/data/fields.php')){
                $field->id = $fid;

                $field->name = optional_param('name','',PARAM_NOTAGS);
                $sql = 'SELECT * from '.$CFG->prefix.'data_fields WHERE name LIKE "'.$field->name.
                       '" AND dataid = '.$data->id.' AND ((id < '.$field->id.') OR (id > '.$field->id.'))';

                if ($field->name and !get_records_sql($sql)){
                    //depends on the type of field, perform native update methods
                    $currentfield = get_record('data_fields','id',$fid);
                    $g = data_get_field($currentfield);
                    $g->update($field);
                    unset($g);
                    
                    // Update the templates.
                    data_replace_field_in_forms($currentfield->dataid, $currentfield->name, $field->name);

                    add_to_log($course->id, 'data', 'fields add', "fields.php?d=$data->id&amp;mode=display&amp;fid=$field->id", $field->id, $cm->id);
                    
                    $displayflag = get_string('fieldupdated','data');
                }
                else {
                    $displayflag = get_string('invalidfieldname','data');
                }
            }
            break;

        default:
            break;
    }

/// Print the tabs

    $currenttab = 'fields';
    include('tabs.php'); 

/// Print the browsing interface
    
    ///get the list of possible fields (plugins)
    $directories = get_list_of_plugins('mod/data/field/');
    $menufield = array();

    foreach ($directories as $directory){
        $menufield[$directory] = get_string($directory,'data');    //get from language files
    }
    asort($menufield);    //sort in alphabetical order
    
    notify ($displayflag);    //print message, if any

    if (($mode == 'new') && confirm_sesskey() ){    //adding new field

        require_once('field/'.$newtype.'/field.class.php');
        $f = 'data_field_'.$newtype;
        $g = new $f;
        $g->display_edit_field(0, $data->id);
        unset($f);
        unset($g);
    }
    
    else if ($mode != 'display'){    //display main form - add new, update, delete

        //echo '<form name="fieldform" action="fields.php?d='.$data->id.'&amp;" method="POST">';
        echo '<form name="fieldform" action="fields.php" method="post">';
        echo '<input name="d" type="hidden" value="'.$data->id.'" />';
        echo '<input type="hidden" name="mode" value="" />';
        echo '<input name="sesskey" value="'.sesskey().'" type="hidden" />';
        print_simple_box_start('center','50%');

        ///New fields
        echo '<table width="100%"><tr>';
        echo '<td>'.get_string('newfield','data').' ';
        choose_from_menu($menufield,'fieldmenu','0','choose','fieldform.mode.value=\'new\';fieldform.submit();','0');
        helpbutton('fields', get_string('addafield','data'), 'data');
        echo '</td></tr>';
        
        /*******************************************
         * Print List of Fields in Quiz Style      *
         *******************************************/
        
        if (!count_records('data_fields','dataid',$data->id)) {
            echo '<tr><td colspan="2">'.get_string('nofieldindatabase','data').'</td></tr>';  // nothing in database
        }
        else {    //else print quiz style list of fields
            
            echo '<tr><td>';
            print_simple_box_start('center','90%');
            echo '<table width="100%"><tr><td align="center"><b>'.get_string('action','data').
                 '</b></td><td><b>'.get_string('fieldname','data').
                 '</b></td><td align="center"><b>'.get_string('type','data').'</b></td></tr>';

            if ($fields = get_records('data_fields','dataid',$data->id)){
                foreach ($fields as $field) {

                    ///Print Action Column

                    echo '<tr><td align="center">';
                    echo '<a href="fields.php?d='.$data->id.'&amp;mode=display&amp;fid='.$field->id.'&amp;sesskey='.sesskey().'">';
                    echo '<img src="'.$CFG->pixpath.'/t/edit.gif" height="11" width="11" border="0" alt="'.get_string('edit').'" /></a>';
                    echo '&nbsp;';
                    echo '<a href="fields.php?d='.$data->id.'&amp;mode=delete&amp;fid='.$field->id.'&amp;sesskey='.sesskey().'">';
                    echo '<img src="'.$CFG->pixpath.'/t/delete.gif" height="11" width="11" border="0" alt="'.get_string('delete').'" /></a>';
                    echo '</td>';

                    ///Print Fieldname Column

                    echo '<td>';
                    echo $field->name;
                    echo '</td>';

                    ///Print Type Column

                    echo '<td align="center">';
                    $g = data_get_field($field);
                    echo $g->image($data->id);    //print type icon
                    echo '</td></tr>';
                }
            }
            echo '</table>';
            print_simple_box_end();
        }    //close else
        
        echo '</td></tr></table>';

        print_simple_box_end();
        echo '</form>';

    }else {    //display native update form

        if (confirm_sesskey()){
            $currentfield = get_record('data_fields','id',$fid);
            $g = data_get_field($currentfield);
            $g->display_edit_field($currentfield->id);
            unset($g);
        }
    }

/// Finish the page
    print_footer($course);

?>