Skip to content

Commit

Permalink
Item13536: rewrite as jQuery plugin
Browse files Browse the repository at this point in the history
  • Loading branch information
@MichaelDaum
MichaelDaum committed Jul 17, 2015
1 parent 25e500b commit a2e3549
Show file tree
Hide file tree
Showing 6 changed files with 294 additions and 243 deletions.
5 changes: 3 additions & 2 deletions data/System/RedDotPlugin.txt
View file
@@ -1,4 +1,4 @@
%META:TOPICINFO{author="ProjectContributor" date="1407719200" format="1.1" version="1"}%
%META:TOPICINFO{author="ProjectContributor" date="1437155427" format="1.1" version="1"}%
---+!! %TOPIC%

This plugin renders a clickable red dot (<a style="color:red; font-weight:bold; padding-left:2px; padding-right:2px; line-height:100%; font-size:18px; text-decoration:none" href="%SCRIPTURLPATH{"edit"}%/%WEB%/%TOPIC%?t=%SERVERTIME{"$year$mo$day$min$sec"}%">.</a>) to ease the edit access to
Expand Down Expand Up @@ -49,11 +49,12 @@ Arguments:


| Plugin Author: | Michael Daum |
| Copyright &copy;: | 2005-2014, Michael Daum http://michaeldaumconsulting.com |
| Copyright &copy;: | 2005-2015, Michael Daum http://michaeldaumconsulting.com |
| License: | GPL ([[http://www.gnu.org/copyleft/gpl.html][GNU General Public License]]) |
| Release: | %$RELEASE% |
| Version: | %$VERSION% |
| Change History: | <!-- versions below in reverse order -->&nbsp; |
| 05 Mar 2015: | rewrite as a jQuery plugin |
| 13 Mar 2013: | modernizing some parts |
| 11 Nov 2010: | use JQICON instead of own getIconUrl() procedure; \
adding js to animate the pencil; \
Expand Down
242 changes: 19 additions & 223 deletions lib/Foswiki/Plugins/RedDotPlugin.pm
View file
@@ -1,6 +1,6 @@
# Plugin for Foswiki - The Free and Open Source Wiki, http://foswiki.org/
#
# Copyright (C) 2005-2014 Michael Daum http://michaeldaumconsulting.com
# Copyright (C) 2005-2015 Michael Daum http://michaeldaumconsulting.com
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
Expand All @@ -10,245 +10,41 @@
# 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, published at
# GNU General Public License for more details, published at
# http://www.gnu.org/copyleft/gpl.html
#
###############################################################################
package Foswiki::Plugins::RedDotPlugin;

use strict;
use warnings;

###############################################################################
use Foswiki::Func ();
use Foswiki::Plugins ();
use Foswiki::Plugins::JQueryPlugin ();


our $VERSION = '3.12';
our $RELEASE = '3.12';
our $VERSION = '4.00';
our $RELEASE = '5 Mar 2015';
our $NO_PREFS_IN_TOPIC = 1;
our $SHORTDESCRIPTION = 'Renders edit-links as little red dots';
our $baseTopic;
our $baseWeb;
our $counter;
our $currentAction;
our $user;

use constant TRACE => 0; # toggle me

###############################################################################
sub writeDebug {
#Foswiki::Func::writeDebug("- RedDotPlugin - " . $_[0]) if TRACE;
print STDERR "- RedDotPlugin - " . $_[0] . "\n" if TRACE;
}
our $SHORTDESCRIPTION = 'Quick-edit links';
our $core;

###############################################################################
sub initPlugin {
($baseTopic, $baseWeb, $user) = @_;

Foswiki::Func::registerTagHandler('REDDOT', \&renderRedDot);
Foswiki::Func::registerTagHandler('REDDOTINIT', \&renderRedDotInit);

$counter = 0;
$baseWeb =~ s/\//\./go;
$currentAction = '';

return 1;
}

###############################################################################
sub renderRedDotInit {
my ($session, $params, $theTopic, $theWeb) = @_;

my $theAnimate = Foswiki::Func::isTrue($params->{animate}, 1);

addStuffToHead($theAnimate);
return "";
}

###############################################################################
sub addStuffToHead {
my $animated = shift;

Foswiki::Func::addToZone('head', 'REDDOTPLUGIN::CSS', <<'HERE');
<link rel='stylesheet' href='%PUBURLPATH%/%SYSTEMWEB%/RedDotPlugin/reddot.css' media='all' />
HERE

if ($animated) {
Foswiki::Func::addToZone('script', 'REDDOTPLUGIN::JS', <<'HERE', "JQUERYPLUGIN::FOSWIKI");
<script src='%PUBURLPATH%/%SYSTEMWEB%/RedDotPlugin/reddot.js'></script>
HERE
}
}

###############################################################################
sub renderRedDot {
my ($session, $params, $theTopic, $theWeb) = @_;

#writeDebug("called renderRedDot($theWeb, $theTopic), parms=".$params->stringify);

my $requestAction = getRequestAction();
return '' unless $requestAction =~ /^view/;

my $theWebTopics = $params->{_DEFAULT} || "$theWeb.$theTopic";
my $theRedirect = $params->{redirect};
my $theText = $params->{text};
my $theStyle = $params->{style} || '';
my $theClass = $params->{class} || '';
my $theIcon = $params->{icon} || 'pencil';
my $theGrant = $params->{grant} || '.*';
my $theTitle = $params->{title};
my $theAnimate = Foswiki::Func::isTrue($params->{animate}, 1);
my $theAction = $params->{action};
my $theTemplate = $params->{template};
my $theParent = $params->{parent};

my $mode = 'redDotIconMode';
if ($theText) {
if (defined $theText) {
$mode = 'redDotTextMode';
} else {
$mode = 'redDotDefaultMode';
$theText = '.';
}
$theText = "$theText";
} else {
$theText = '%JQICON{"'.$theIcon.'" format="<img src=\'$iconPath\' width=\'16\' height=\'16\' class=\'$iconClass\' $iconAlt/>"}%';
}
if ($theAnimate) {
$mode .= ' redDotAnimated';
}

my $query = Foswiki::Func::getCgiQuery();
unless ($theRedirect) {
my $redirectPref = Foswiki::Func::getPreferencesValue("REDDOT_REDIRECT");
if ($redirectPref) {
$redirectPref = Foswiki::Func::expandCommonVariables($redirectPref);
my ($redirectWeb, $redirectTopic) = Foswiki::Func::normalizeWebTopicName($baseWeb, $redirectPref);
$theRedirect = Foswiki::Func::getScriptUrl($redirectWeb, $redirectTopic, 'view');
} else {
my $queryString = $query->query_string;

# SMELL: double quotes, even encoded truncate the redirectto.
# so we double encode them
$queryString =~ s/\%22/\%2522/g;

$theRedirect = Foswiki::Func::getScriptUrl($baseWeb, $baseTopic, 'view').
'?'.$queryString;
}
$theRedirect .= "#reddot$counter";
}
Foswiki::Plugins::JQueryPlugin::registerPlugin('reddot', 'Foswiki::Plugins::RedDotPlugin::Core');

# find the first webtopic that we have access to
my $thisWeb;
my $thisTopic;
my $hasEditAccess = 0;
my $wikiName = Foswiki::Func::getWikiName();
$core = undef;

Foswiki::Func::registerTagHandler('REDDOT', sub {
my $session = shift;

foreach my $webTopic (split(/\s*,\s*/, $theWebTopics)) {
#writeDebug("testing webTopic=$webTopic");
$core = Foswiki::Plugins::JQueryPlugin::createPlugin('reddot', $session)
unless defined $core;

($thisWeb, $thisTopic) =
Foswiki::Func::normalizeWebTopicName($baseWeb, $webTopic);
$thisWeb =~ s/\//\./go;

if (Foswiki::Func::topicExists($thisWeb, $thisTopic)) {
#writeDebug("checking access on $thisWeb.$thisTopic for $wikiName");
$hasEditAccess = Foswiki::Func::checkAccessPermission("CHANGE",
$wikiName, undef, $thisTopic, $thisWeb);
if ($hasEditAccess) {
$hasEditAccess = 0 unless $wikiName =~ /$theGrant/;
# SMELL: use the users and groups functions to check
# if we are in theGrant
}
if ($hasEditAccess) {
#writeDebug("granted");
last;
}
}
}

if (!$hasEditAccess) {
return $core->handleRedDot(@_) if $core;
return '';
}

#writeDebug("rendering red dot on $thisWeb.$thisTopic for $wikiName");

my %params = ();
$params{t} = time();
$params{action} = $theAction if defined $theAction;
$params{template} = $theTemplate if defined $theTemplate;
$params{redirectto} = $theRedirect if $theRedirect ne "$thisWeb.$thisTopic";

# red dotting
my $result =
"<span class='redDot $mode $theClass' ";
$result .= "data-parent='$theParent' " if defined $theParent;
$result .= "style='$theStyle' " if $theStyle;
$result .=
'><a id=\'reddot'.($counter++).'\' '.
'href=\''.
Foswiki::Func::getScriptUrl($thisWeb,$thisTopic, 'edit', %params);

$result .= '\' ';
if ($theTitle) {
$result .= "title='%ENCODE{\"$theTitle\" type=\"entity\"}%'";
} else {
$result .= "title='Edit&nbsp;<nop>$thisWeb.$thisTopic'";
}
$result .= ">$theText</a></span>";

#writeDebug("done renderRedDot");

addStuffToHead($theAnimate);

return $result;
}

###############################################################################
sub urlEncode {
my $text = shift;
});

$text =~ s/([^0-9a-zA-Z-_.:~!*'()\/%])/'%'.sprintf('%02x',ord($1))/ge;

return $text;
}

###############################################################################
# take the REQUEST_URI, strip off the PATH_INFO from the end, the last word
# is the action; this is done that complicated as there may be different
# paths for the same action depending on the apache configuration (rewrites, aliases)
sub getRequestAction {

return $currentAction if $currentAction;

my $request = Foswiki::Func::getCgiQuery();

if (defined($request->action)) {
$currentAction = $request->action();
} else {
my $context = Foswiki::Func::getContext();

# not all cgi actions we want to distinguish set their context
# so only use those we are sure of
return 'edit' if $context->{'edit'};
return 'view' if $context->{'view'};
return 'save' if $context->{'save'};
# TODO: more

# fall back to analyzing the path info
my $pathInfo = $ENV{'PATH_INFO'} || '';
$currentAction = $ENV{'REQUEST_URI'} || '';
if ($currentAction =~ /^.*?\/([^\/]+)$pathInfo.*$/) {
$currentAction = $1;
} else {
$currentAction = 'view';
}
#writeDebug("PATH_INFO=$ENV{'PATH_INFO'}");
#writeDebug("REQUEST_URI=$ENV{'REQUEST_URI'}");
#writeDebug("currentAction=$currentAction");

}

return $currentAction;
return 1;
}

1;

0 comments on commit a2e3549

Please sign in to comment.