Adding new data field type, latlong, to HEAD

diff --git a/mod/data/field/latlong/field.class.php b/mod/data/field/latlong/field.class.php
new file mode 100755 (executable)
index 0000000..0d18e14
--- /dev/null
+++ b/mod/data/field/latlong/field.class.php
@@ -0,0 +1,174 @@
+<?php 
+///////////////////////////////////////////////////////////////////////////
+//                                                                       //
+// NOTICE OF COPYRIGHT                                                   //
+//                                                                       //
+// Moodle - Modular Object-Oriented Dynamic Learning Environment         //
+//          http://moodle.org                                            //
+//                                                                       //
+// Copyright (C) 1999-onwards Moodle Pty Ltd  http://moodle.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                         //
+//                                                                       //
+///////////////////////////////////////////////////////////////////////////
+
+class data_field_latlong extends data_field_base {
+
+    var $type = 'latlong';
+    
+    // This is an array of URL schemes for linking out to services, using the float values of lat and long.
+    // In each scheme, the special markers @lat@ and @long@ will be replaced by the float values.
+    // The config options for the field store each service name that should be displayed, in a comma-separated
+    // field. Therefore please DO NOT include commas in the service names if you are adding extra services.
+    var $linkoutservices = array(
+          "Google Maps" => "http://maps.google.com/maps?q=@lat@,+@long@&iwloc=A&hl=en",
+          "Google Earth" => "@wwwroot@/mod/data/field/latlong/kml.php?d=@dataid@&fieldid=@fieldid@&rid=@recordid@",
+          "Geabios" => "http://www.geabios.com/html/services/maps/PublicMap.htm?lat=@lat@&lon=@long@&fov=0.3&title=Moodle%20data%20item",
+          "OpenStreetMap" => "http://www.openstreetmap.org/index.html?lat=@lat@&lon=@long@&zoom=11",
+          "Multimap" => "http://www.multimap.com/map/browse.cgi?scale=200000&lon=@long@&lat=@lat@&icon=x"
+          );
+    // Other map sources listed at http://kvaleberg.com/extensions/mapsources/index.php?params=51_30.4167_N_0_7.65_W_region:earth
+
+
+
+    function data_field_latlong($field=0, $data=0) {
+        parent::data_field_base($field, $data);
+    }
+
+    function display_add_field($recordid=0){
+        global $CFG;
+
+        $lat = '';
+        $long = '';
+
+        if ($recordid){
+            if ($content = get_record('data_content', 'fieldid', $this->field->id, 'recordid', $recordid)) {
+                $lat  = $content->content;
+                $long = $content->content1;
+            }
+        }
+
+        $str = '<div title="'.$this->field->description.'">';
+               $str .= '<table><tr><td align="right">';
+               $str .= '<label for="field_'.$this->field->id.'_0">' . get_string('latitude', 'data') . '</label>:</td><td><input type="text" name="field_'.$this->field->id.'_0" id="field_'.$this->field->id.'_0" value="'.$lat.'" size="10" />°N</td></tr>';
+               $str .= '<tr><td align="right"><label for="field_'.$this->field->id.'_1">' . get_string('longitude', 'data') . '</label>:</td><td><input type="text" name="field_'.$this->field->id.'_1" id="field_'.$this->field->id.'_1" value="'.$long.'" size="10" />°E</td></tr>';
+               $str .= '</table>';
+        $str .= '</div>';
+        
+        return $str;
+    }
+
+    function display_browse_field($recordid, $template) {
+        global $CFG;
+        if ($content = get_record('data_content', 'fieldid', $this->field->id, 'recordid', $recordid)){
+            $lat = empty($content->content)? '':$content->content;
+            $long = empty($content->content1)? '':$content->content1;
+
+            if (empty($lat) or empty($long)) {
+                return '';
+            }
+            
+                 if($lat < 0) {
+                     $compasslat = "" . sprintf('%01.4f', 0 - $lat) . '°S';
+              } else {
+                     $compasslat = "" . sprintf('%01.4f', $lat) . "°N";
+                 }
+                 if($long < 0) {
+                     $compasslong = "" . sprintf('%01.4f', 0 - $long) . '°W';
+              } else {
+                     $compasslong = "" . sprintf('%01.4f', $long) . "°E";
+                 }
+                 
+            $str = '<form style="display:inline;">';
+            $str.= "$compasslat, $compasslong";
+            
+            
+            // Now let's create the jump-to-services link
+            $servicesshown = explode(',', $this->field->param1);
+
+            // These are the different things that can be magically inserted into URL schemes
+            $urlreplacements = array(
+                '@lat@'=> $lat,
+                '@long@'=> $long,
+                '@wwwroot@'=> $CFG->wwwroot,
+                '@contentid@'=> $content->id,
+                '@dataid@'=> $this->data->id,
+                '@courseid@'=> $this->data->course,
+                '@fieldid@'=> $content->fieldid,
+                '@recordid@'=> $content->recordid,
+                );
+
+            if(sizeof($servicesshown)==1 && $servicesshown[0]) {
+                $str .= " <a href='"
+                          . str_replace(array_keys($urlreplacements), array_values($urlreplacements), $this->linkoutservices[$servicesshown[0]])
+                          ."'>$servicesshown[0]</a> ";
+            } elseif (sizeof($servicesshown)>1) {
+                               $str .= "\n<select name='jumpto'>";
+       
+                               foreach($servicesshown as $servicename){
+                                       // Add a link to a service
+                                       $str .= "\n  <option value='"
+                                                          . str_replace(array_keys($urlreplacements), array_values($urlreplacements), $this->linkoutservices[$servicename])
+                                                          . "'>".htmlspecialchars($servicename)."</option>";
+                               }
+                               // NB! If you are editing this, make sure you don't break the javascript reference "previousSibling"
+                               //   which allows the "Go" button to refer to the drop-down selector.
+                               $str .= "\n</select><input type='button' value='" . get_string('go') . "' onclick='if(previousSibling.value){self.location=previousSibling.value}'/>";
+            }
+            
+            $str.= '</form>';
+            
+            return $str;
+        }
+        return false;
+    }
+
+    function update_content($recordid, $value, $name='') {
+        $content = new object;
+        $content->fieldid = $this->field->id;
+        $content->recordid = $recordid;
+
+        $names = explode('_', $name);
+        switch ($names[2]){
+            case 0:    // update lat
+                $content->content = (float)$value;
+                break;
+            case 1:    // update long
+                $content->content1 = (float)$value;
+                break;
+            default:
+                break;
+        }
+        
+        if ($oldcontent = get_record('data_content','fieldid', $this->field->id, 'recordid', $recordid)) {
+            $content->id = $oldcontent->id;
+            return update_record('data_content', $content);
+        } else {
+            return insert_record('data_content', $content);
+        }
+    }
+
+    function get_sort_sql($fieldname) {
+        global $CFG;
+
+        switch ($CFG->dbtype) {
+            case 'mysql':   // string in an arithmetic operation is converted to a floating-point number
+                return '('.$fieldname.'+0.0)';  
+
+            default:
+                return 'CAST('.$fieldname.' AS REAL)';  
+        }
+    }
+}
+
+?>
\ No newline at end of file

diff --git a/mod/data/field/latlong/icon.gif b/mod/data/field/latlong/icon.gif
new file mode 100644 (file)
index 0000000..ec54dc1
Binary files /dev/null and b/mod/data/field/latlong/icon.gif differ

diff --git a/mod/data/field/latlong/kml.php b/mod/data/field/latlong/kml.php
new file mode 100644 (file)
index 0000000..d117095
--- /dev/null
+++ b/mod/data/field/latlong/kml.php
@@ -0,0 +1,141 @@
+<?php
+
+// A lot of this initial stuff is copied from mod/data/view.php
+
+require_once('../../../../config.php');
+require_once('../../lib.php');
+
+// Optional params: row id "rid" - if set then export just one, otherwise export all
+
+$d       = required_param('d', PARAM_INT);   // database id
+$fieldid = required_param('fieldid', PARAM_INT);   // field id
+$rid     = optional_param('rid', 0, PARAM_INT);    //record id
+
+
+if ($rid) {
+       if (! $record = get_record('data_records', 'id', $rid)) {
+               error('Record ID is incorrect');
+       }
+       if (! $data = get_record('data', 'id', $record->dataid)) {
+               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 (! $field = get_record('data_fields', 'id', $fieldid)) {
+               error('Field ID is incorrect');
+       }
+       if (! $field->type == 'latlong') { // Make sure we're looking at a latlong data type!
+               error('Field ID is incorrect');
+       }
+       if (! $content = get_record('data_content', 'fieldid', $fieldid, 'recordid', $rid)) {
+               error('Field content not found');
+       }
+} else {   // We must have $d
+       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 (! $field = get_record('data_fields', 'id', $fieldid)) {
+               error('Field ID is incorrect');
+       }
+       if (! $field->type == 'latlong') { // Make sure we're looking at a latlong data type!
+               error('Field ID is incorrect');
+       }
+       $record = NULL;
+}
+
+require_course_login($course, true, $cm);
+
+/// If it's hidden then it's don't show anything.  :)
+if (empty($cm->visible) and !isteacher($course->id)) {
+       $strdatabases = get_string("modulenameplural", "data");
+       $navigation = "<a href=\"index.php?id=$course->id\">$strdatabases</a> ->";
+       print_header_simple(format_string($data->name), "",
+                        "$navigation ".format_string($data->name), "", "", true, '', navmenu($course, $cm));
+       notice(get_string("activityiscurrentlyhidden"));
+}
+
+/// If we have an empty Database then redirect because this page is useless without data
+if (isteacher($course->id)) {
+       if (!record_exists('data_fields','dataid',$data->id)) {      // Brand new database!
+               redirect($CFG->wwwroot.'/mod/data/field.php?d='.$data->id);  // Redirect to field entry
+       }
+}
+
+
+
+
+//header('Content-type: text/plain'); // This is handy for debug purposes to look at the KML in the browser
+header('Content-type: application/vnd.google-earth.kml+xml kml');
+header('Content-Disposition: attachment; filename="moodleearth-'.$d.'-'.$rid.'-'.$fieldid.'.kml"');
+
+//print_r($record);
+
+echo data_latlong_kml_top();
+
+if($rid) { // List one single item
+    $pm->name = "Item #$rid";
+    $pm->description = "&lt;a href='$CFG->wwwroot/mod/data/view.php?d=$d&amp;rid=$rid'&gt;Item #$rid&lt;/a&gt; in Moodle data activity";
+    $pm->long = $content->content1;
+    $pm->lat = $content->content;
+    echo data_latlong_kml_placemark($pm);
+} else {   // List all items in turn
+
+    $contents = get_records('data_content', 'fieldid', $fieldid);
+    
+    foreach($contents as $content) {
+               $pm->name = "Item #$content->recordid";
+               $pm->description = "&lt;a href='$CFG->wwwroot/mod/data/view.php?d=$d&amp;rid=$content->recordid'&gt;Item #$content->recordid&lt;/a&gt; in Moodle data activity";
+               $pm->long = $content->content1;
+               $pm->lat = $content->content;
+               echo data_latlong_kml_placemark($pm);
+    }
+
+}
+
+echo data_latlong_kml_bottom();
+
+
+
+
+function data_latlong_kml_top() {
+    return '<?xml version="1.0" encoding="UTF-8"?>
+<kml xmlns="http://earth.google.com/kml/2.0">
+<Document>
+';
+}
+
+function data_latlong_kml_placemark($pm) {
+    return '<Placemark>
+  <description>'.$pm->description.'</description>
+  <name>'.$pm->name.'</name>
+  <LookAt>
+    <longitude>'.$pm->long.'</longitude>
+    <latitude>'.$pm->lat.'</latitude>
+    <range>30500.8880792294568</range>
+    <tilt>46.72425699662645</tilt>
+    <heading>0.0</heading>
+  </LookAt>
+  <visibility>0</visibility>
+  <Point>
+    <extrude>1</extrude>
+    <altitudeMode>relativeToGround</altitudeMode>
+    <coordinates>'.$pm->long.','.$pm->lat.',50</coordinates>
+  </Point>
+</Placemark>
+';
+}
+
+function data_latlong_kml_bottom() {
+    return '</Document></kml>';
+}
+

diff --git a/mod/data/field/latlong/mod.html b/mod/data/field/latlong/mod.html
new file mode 100755 (executable)
index 0000000..03adc77
--- /dev/null
+++ b/mod/data/field/latlong/mod.html
@@ -0,0 +1,24 @@
+<table width="100%">
+    <tr>
+        <td class="c0"><?php echo get_string('fieldname', 'data'); ?>:</td>
+        <td class="c1"><input class="fieldname" type="text" name="name" id="name" value = "<?php echo($this->field->name); ?>" /></td>
+    </tr>
+    <tr>
+        <td class="c0"><?php echo get_string('fielddescription', 'data'); ?>:</td>
+        <td class="c1"><input class="fielddescription" type="text" name="description" id="description" value = "<?php echo ($this->field->description);?>" /></td>
+    </tr>
+    <tr>
+        <td class="c0"><?php echo get_string('latlonglinkservicesdisplayed', 'data'); ?>:</td>
+        <td class="c1">
+          <select class="linkservicesdisplayed" type="text" name="param1[]" id="param1" multiple="multiple" size="<?php echo sizeof($this->linkoutservices) ?>">
+            <?php
+            $serviceschosen = explode(',', htmlspecialchars($this->field->param1));
+            foreach($this->linkoutservices as $servicename=>$serviceurl) {
+              $servicename = htmlspecialchars($servicename);
+              echo "\n  <option" . (array_search($servicename, $serviceschosen)===false ? '' : ' selected="selected"') . ">$servicename</option>";
+            }
+            ?>
+          </select>
+        </td>
+    </tr>
+</table>