Implement user interface for user to preview what location they are sharing with a notice

This commit is contained in:
Craig Andrews 2009-12-29 16:17:17 -05:00
parent e152bec282
commit 98ce7daf56
7 changed files with 240 additions and 7 deletions

93
actions/geocode.php Normal file
View File

@ -0,0 +1,93 @@
<?php
/**
* Geocode action class
*
* PHP version 5
*
* @category Action
* @package StatusNet
* @author Craig Andrews <candrews@integralblue.com>
* @license http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
* @link http://status.net/
*
* StatusNet - the distributed open-source microblogging tool
* Copyright (C) 2008, 2009, StatusNet, Inc.
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as published by
* the Free Software Foundation, either version 3 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 Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
if (!defined('STATUSNET') && !defined('LACONICA')) {
exit(1);
}
/**
* Geocode action class
*
* @category Action
* @package StatusNet
* @author Craig Andrews <candrews@integralblue.com>
* @license http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
* @link http://status.net/
*/
class GeocodeAction extends Action
{
function prepare($args)
{
parent::prepare($args);
$token = $this->trimmed('token');
if (!$token || $token != common_session_token()) {
$this->clientError(_('There was a problem with your session token. '.
'Try again, please.'));
}
$this->lat = $this->trimmed('lat');
$this->lon = $this->trimmed('lon');
$this->location = Location::fromLatLon($this->lat, $this->lon);
return true;
}
/**
* Class handler
*
* @param array $args query arguments
*
* @return nothing
*
**/
function handle($args)
{
header('Content-Type: application/json; charset=utf-8');
$location_object = array();
$location_object['lat']=$this->lat;
$location_object['lon']=$this->lon;
if($this->location) {
$location_object['location_id']=$this->location->location_id;
$location_object['location_ns']=$this->location->location_ns;
$location_object['name']=$this->location->getName();
$location_object['url']=$this->location->getUrl();
}
print(json_encode($location_object));
}
/**
* Is this action read-only?
*
* @return boolean true
*/
function isReadOnly($args)
{
return true;
}
}
?>

View File

@ -184,7 +184,7 @@ class NewnoticeAction extends Action
$options = array('reply_to' => ($replyto == 'false') ? null : $replyto);
if ($user->shareLocation()) {
if ($user->shareLocation() && $this->arg('notice_data-location_enabled')) {
$locOptions = Notice::locationOptions($this->trimmed('lat'),
$this->trimmed('lon'),

96
js/jquery.cookie.js Normal file
View File

@ -0,0 +1,96 @@
/**
* Cookie plugin
*
* Copyright (c) 2006 Klaus Hartl (stilbuero.de)
* Dual licensed under the MIT and GPL licenses:
* http://www.opensource.org/licenses/mit-license.php
* http://www.gnu.org/licenses/gpl.html
*
*/
/**
* Create a cookie with the given name and value and other optional parameters.
*
* @example $.cookie('the_cookie', 'the_value');
* @desc Set the value of a cookie.
* @example $.cookie('the_cookie', 'the_value', { expires: 7, path: '/', domain: 'jquery.com', secure: true });
* @desc Create a cookie with all available options.
* @example $.cookie('the_cookie', 'the_value');
* @desc Create a session cookie.
* @example $.cookie('the_cookie', null);
* @desc Delete a cookie by passing null as value. Keep in mind that you have to use the same path and domain
* used when the cookie was set.
*
* @param String name The name of the cookie.
* @param String value The value of the cookie.
* @param Object options An object literal containing key/value pairs to provide optional cookie attributes.
* @option Number|Date expires Either an integer specifying the expiration date from now on in days or a Date object.
* If a negative value is specified (e.g. a date in the past), the cookie will be deleted.
* If set to null or omitted, the cookie will be a session cookie and will not be retained
* when the the browser exits.
* @option String path The value of the path atribute of the cookie (default: path of page that created the cookie).
* @option String domain The value of the domain attribute of the cookie (default: domain of page that created the cookie).
* @option Boolean secure If true, the secure attribute of the cookie will be set and the cookie transmission will
* require a secure protocol (like HTTPS).
* @type undefined
*
* @name $.cookie
* @cat Plugins/Cookie
* @author Klaus Hartl/klaus.hartl@stilbuero.de
*/
/**
* Get the value of a cookie with the given name.
*
* @example $.cookie('the_cookie');
* @desc Get the value of a cookie.
*
* @param String name The name of the cookie.
* @return The value of the cookie.
* @type String
*
* @name $.cookie
* @cat Plugins/Cookie
* @author Klaus Hartl/klaus.hartl@stilbuero.de
*/
jQuery.cookie = function(name, value, options) {
if (typeof value != 'undefined') { // name and value given, set cookie
options = options || {};
if (value === null) {
value = '';
options.expires = -1;
}
var expires = '';
if (options.expires && (typeof options.expires == 'number' || options.expires.toUTCString)) {
var date;
if (typeof options.expires == 'number') {
date = new Date();
date.setTime(date.getTime() + (options.expires * 24 * 60 * 60 * 1000));
} else {
date = options.expires;
}
expires = '; expires=' + date.toUTCString(); // use expires attribute, max-age is not supported by IE
}
// CAUTION: Needed to parenthesize options.path and options.domain
// in the following expressions, otherwise they evaluate to undefined
// in the packed version for some reason...
var path = options.path ? '; path=' + (options.path) : '';
var domain = options.domain ? '; domain=' + (options.domain) : '';
var secure = options.secure ? '; secure' : '';
document.cookie = [name, '=', encodeURIComponent(value), expires, path, domain, secure].join('');
} else { // only name given, get cookie
var cookieValue = null;
if (document.cookie && document.cookie != '') {
var cookies = document.cookie.split(';');
for (var i = 0; i < cookies.length; i++) {
var cookie = jQuery.trim(cookies[i]);
// Does this cookie string begin with the name we want?
if (cookie.substring(0, name.length + 1) == (name + '=')) {
cookieValue = decodeURIComponent(cookie.substring(name.length + 1));
break;
}
}
}
return cookieValue;
}
};

View File

@ -50,7 +50,9 @@ var SN = { // StatusNet
NoticeLat: 'notice_data-lat',
NoticeLon: 'notice_data-lon',
NoticeLocationId: 'notice_data-location_id',
NoticeLocationNs: 'notice_data-location_ns'
NoticeLocationNs: 'notice_data-location_ns',
NoticeLocationName: 'notice_data-location_name',
NoticeLocationCookieName: 'location_enabled'
}
},
@ -436,10 +438,44 @@ var SN = { // StatusNet
},
NoticeLocationAttach: function() {
if(navigator.geolocation) navigator.geolocation.watchPosition(function(position) {
if($('#notice_data-location_enabled').size()) {
if(navigator.geolocation) {
$('#notice_data-location_enabled').change(function() {
$.cookie(SN.C.S.NoticeLocationCookieName, $('#notice_data-location_enabled').attr('checked'));
if($('#notice_data-location_enabled').attr('checked')) {
$('#'+SN.C.S.NoticeLocationName).show();
$('#'+SN.C.S.NoticeLocationName).addClass('processing');
navigator.geolocation.getCurrentPosition(function(position) {
$('#'+SN.C.S.NoticeLat).val(position.coords.latitude);
$('#'+SN.C.S.NoticeLon).val(position.coords.longitude);
var data = {'lat': position.coords.latitude,'lon': position.coords.longitude, 'token': $('#token').val()};
$.getJSON($('#notice_data-location_enabled_container').attr('data-geocode-url'), data,function(location) {
$('#'+SN.C.S.NoticeLocationName).removeClass('processing');
if(typeof(location.location_ns)!="undefined") $('#'+SN.C.S.NoticeLocationNs).val(location.location_ns);
if(typeof(location.location_id)!="undefined") $('#'+SN.C.S.NoticeLocationId).val(location.location_id);
if(typeof(location.name)=="undefined") {
$('#'+SN.C.S.NoticeLocationName).text(position.coords.latitude + ' ' + position.coords.longitude);
} else {
$('#'+SN.C.S.NoticeLocationName).text(location.name);
$('#'+SN.C.S.NoticeLocationName).attr('href',location.url);
}
});
});
} else {
$('#'+SN.C.S.NoticeLocationName).hide();
$('#'+SN.C.S.NoticeLat).val("");
$('#'+SN.C.S.NoticeLon).val("");
$('#'+SN.C.S.NoticeLocationNs).val("");
$('#'+SN.C.S.NoticeLocationId).val("");
}
});
var cookieVal = $.cookie(SN.C.S.NoticeLocationCookieName);
$('#notice_data-location_enabled').attr('checked',(cookieVal == null || cookieVal == 'true'));
$('#notice_data-location_enabled').change();
} else {
$('#notice_data-location_enabled_container').remove();
}
}
},
NewDirectMessage: function() {

View File

@ -252,6 +252,7 @@ class Action extends HTMLOutputter // lawsuit
if (Event::handle('StartShowJQueryScripts', array($this))) {
$this->script('js/jquery.min.js');
$this->script('js/jquery.form.js');
$this->script('js/jquery.cookie.js');
$this->script('js/jquery.joverlay.min.js');
Event::handle('EndShowJQueryScripts', array($this));
}

View File

@ -220,5 +220,11 @@ class NoticeForm extends Form
'name' => 'status_submit',
'type' => 'submit',
'value' => _('Send')));
if($this->user->shareLocation()) {
$this->out->elementStart('div',array('id' => 'notice_data-location_enabled_container', 'data-geocode-url' => common_local_url('geocode')));
$this->out->checkbox('notice_data-location_enabled',_('Share your location '));
$this->out->element('a', array('style' => 'display: none', 'target' => '_blank', 'id' => 'notice_data-location_name'), _('Finding your location...'));
$this->out->elementEnd('div');
}
}
}

View File

@ -100,7 +100,8 @@ class Router
'sandbox', 'unsandbox',
'silence', 'unsilence',
'repeat',
'deleteuser');
'deleteuser',
'geocode');
foreach ($main as $a) {
$m->connect('main/'.$a, array('action' => $a));