649 lines
16 KiB
JavaScript
649 lines
16 KiB
JavaScript
// The Antville Project
|
||
// http://code.google.com/p/antville
|
||
//
|
||
// Copyright 2007-2011 by Tobi Schäfer.
|
||
//
|
||
// Copyright 2001–2007 Robert Gaggl, Hannes Wallnöfer, Tobi Schäfer,
|
||
// Matthias & Michael Platzer, Christoph Lincke.
|
||
//
|
||
// Licensed under the Apache License, Version 2.0 (the ``License'');
|
||
// you may not use this file except in compliance with the License.
|
||
// You may obtain a copy of the License at
|
||
//
|
||
// http://www.apache.org/licenses/LICENSE-2.0
|
||
//
|
||
// Unless required by applicable law or agreed to in writing, software
|
||
// distributed under the License is distributed on an ``AS IS'' BASIS,
|
||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||
// See the License for the specific language governing permissions and
|
||
// limitations under the License.
|
||
//
|
||
// $Revision$
|
||
// $Author$
|
||
// $Date$
|
||
// $URL$
|
||
|
||
/**
|
||
* @fileOverview Defines the extensions of Helma’s built-in
|
||
* HopObject prototype.
|
||
*/
|
||
|
||
/**
|
||
*
|
||
* @param {HopObject} collection
|
||
* @param {Object} options Optional flags, e.g. to force or prevent any
|
||
* conditional checks of individual prototype’s remove() methods
|
||
*/
|
||
HopObject.remove = function(options) {
|
||
var item;
|
||
while (this.size() > 0) {
|
||
item = this.get(0);
|
||
if (item.constructor.remove) {
|
||
item.constructor.remove.call(item, options);
|
||
} else if (!options) {
|
||
item.remove();
|
||
} else {
|
||
throw Error("Missing static " + item.constructor.name +
|
||
".remove() method");
|
||
}
|
||
}
|
||
return;
|
||
}
|
||
|
||
/**
|
||
*
|
||
* @param {String} name
|
||
* @param {HopObject} collection
|
||
*/
|
||
HopObject.getFromPath = function(name, collection) {
|
||
if (name) {
|
||
var site;
|
||
if (name.contains("/")) {
|
||
var parts = name.split("/");
|
||
site = root.get(parts[0]);
|
||
name = parts[1];
|
||
} else {
|
||
site = res.handlers.site;
|
||
}
|
||
if (site && site.getPermission("main")) {
|
||
return site[collection].get(name);
|
||
}
|
||
}
|
||
return null;
|
||
}
|
||
|
||
/**
|
||
* Helma’s built-in HopObject with Antville’s extensions.
|
||
* @name HopObject
|
||
* @constructor
|
||
*/
|
||
|
||
/**
|
||
*
|
||
* @param {Object} values
|
||
*/
|
||
HopObject.prototype.map = function(values) {
|
||
for (var i in values) {
|
||
this[i] = values[i];
|
||
}
|
||
return;
|
||
}
|
||
|
||
/**
|
||
*
|
||
*/
|
||
HopObject.prototype.onRequest = function() {
|
||
// Checking if we are on the correct host to prevent at least some XSS issues
|
||
if (req.action !== "notfound" && req.action !== "error" &&
|
||
this.href().startsWith("http://") &&
|
||
!this.href().toLowerCase().startsWith(req.servletRequest.scheme +
|
||
"://" + req.servletRequest.serverName.toLowerCase())) {
|
||
res.redirect(this.href(req.action === "main" ? String.EMPTY : req.action));
|
||
}
|
||
|
||
User.autoLogin();
|
||
res.handlers.membership = User.getMembership();
|
||
|
||
if (User.getCurrentStatus() === User.BLOCKED) {
|
||
session.data.status = 403;
|
||
session.data.error = gettext("Your account has been blocked.") + String.SPACE +
|
||
gettext("Please contact an administrator for further information.");
|
||
User.logout();
|
||
res.redirect(root.href("error"));
|
||
}
|
||
|
||
if (res.handlers.site.status === Site.BLOCKED &&
|
||
!User.require(User.PRIVILEGED)) {
|
||
session.data.status = 403;
|
||
session.data.error = gettext("The site you requested has been blocked.") +
|
||
String.SPACE + gettext("Please contact an administrator for further information.");
|
||
res.redirect(root.href("error"));
|
||
}
|
||
|
||
res.handlers.layout = res.handlers.site.layout || new Layout;
|
||
res.skinpath = res.handlers.layout.getSkinPath();
|
||
|
||
if (!this.getPermission(req.action)) {
|
||
if (!session.user) {
|
||
User.setLocation(root.href() + req.path);
|
||
res.message = gettext("Please login first.");
|
||
res.redirect(res.handlers.site.members.href("login"));
|
||
}
|
||
User.getLocation();
|
||
res.status = 401;
|
||
res.data.title = gettext("{0} 401 Error", root.title);
|
||
res.data.body = root.renderSkinAsString("$Root#error", {error:
|
||
gettext("You are not allowed to access this part of the site.")});
|
||
res.handlers.site.renderSkin("Site#page");
|
||
session.data.error = null;
|
||
res.stop();
|
||
}
|
||
|
||
res.meta.values = {};
|
||
res.handlers.site.renderSkinAsString("Site#values");
|
||
return;
|
||
}
|
||
|
||
/**
|
||
* @returns Boolean
|
||
*/
|
||
HopObject.prototype.getPermission = function() {
|
||
return true;
|
||
}
|
||
|
||
// Marking some prototype names used in res.message of HopObject.delete_action()
|
||
markgettext("Comment");
|
||
markgettext("File");
|
||
markgettext("Image");
|
||
markgettext("Membership");
|
||
markgettext("Poll");
|
||
markgettext("Story");
|
||
|
||
HopObject.prototype.delete_action = function() {
|
||
if (req.postParams.proceed) {
|
||
try {
|
||
var parent = this._parent;
|
||
var url = this.constructor.remove.call(this, req.postParams) ||
|
||
parent.href();
|
||
res.message = gettext("{0} was successfully deleted.", gettext(this._prototype));
|
||
res.redirect(User.getLocation() || url);
|
||
} catch(ex) {
|
||
res.message = ex;
|
||
app.log(ex);
|
||
}
|
||
}
|
||
|
||
res.data.action = this.href(req.action);
|
||
res.data.title = gettext("Confirm Deletion");
|
||
res.data.body = this.renderSkinAsString("$HopObject#confirm", {
|
||
text: this.getConfirmText()
|
||
});
|
||
res.handlers.site.renderSkin("Site#page");
|
||
return;
|
||
}
|
||
|
||
/**
|
||
* @returns {Object}
|
||
*/
|
||
HopObject.prototype.touch = function() {
|
||
return this.map({
|
||
modified: new Date,
|
||
modifier: session.user
|
||
});
|
||
}
|
||
|
||
/**
|
||
*
|
||
*/
|
||
HopObject.prototype.log = function() {
|
||
var entry = new LogEntry(this, "main");
|
||
app.data.entries.push(entry);
|
||
return;
|
||
}
|
||
|
||
/**
|
||
*
|
||
* @param {String} action
|
||
*/
|
||
HopObject.prototype.notify = function(action) {
|
||
var self = this;
|
||
var site = res.handlers.site;
|
||
|
||
var getPermission = function(scope, mode, status) {
|
||
if (scope === Admin.NONE || mode === Site.NOBODY ||
|
||
status === Site.BLOCKED) {
|
||
return false;
|
||
}
|
||
var scopes = [Admin.REGULAR, Admin.TRUSTED];
|
||
if (scopes.indexOf(status) < scopes.indexOf(scope)) {
|
||
return false;
|
||
}
|
||
if (!Membership.require(mode)) {
|
||
return false;
|
||
}
|
||
return true;
|
||
}
|
||
|
||
// Helper method for debugging
|
||
var renderMatrix = function() {
|
||
var buf = ['<table border=1 cellspacing=0>'];
|
||
for each (var scope in Admin.getNotificationScopes()) {
|
||
for each (var mode in Site.getNotificationModes()) {
|
||
for each (var status in Site.getStatus()) {
|
||
var perm = getPermission(scope.value, mode.value, status.value);
|
||
buf.push('<tr style="');
|
||
perm && buf.push('color: blue;');
|
||
if (scope.value === root.notificationScope && mode.value ===
|
||
site.notificationMode && status.value === site.status) {
|
||
buf.push(' background-color: yellow;');
|
||
}
|
||
buf.push('">');
|
||
buf.push('<td>', scope.value, '</td>');
|
||
buf.push('<td>', status.value, '</td>');
|
||
buf.push('<td>', mode.value, '</td>');
|
||
buf.push('<td>', perm, '</td>');
|
||
buf.push('</tr>');
|
||
}
|
||
}
|
||
}
|
||
buf.push('</table>');
|
||
res.write(buf.join(""));
|
||
return;
|
||
}
|
||
|
||
switch (action) {
|
||
case "comment":
|
||
action = "create"; break;
|
||
}
|
||
|
||
var currentMembership = res.handlers.membership;
|
||
site.members.forEach(function() {
|
||
var membership = res.handlers.membership = this;
|
||
if (getPermission(root.notificationScope, site.notificationMode, site.status)) {
|
||
sendMail(membership.creator.email, gettext("[{0}] Notification of site changes",
|
||
root.title), self.renderSkinAsString("$HopObject#notify_" + action));
|
||
}
|
||
});
|
||
res.handlers.membership = currentMembership;
|
||
return;
|
||
}
|
||
|
||
/**
|
||
* @returns {Tag[]}
|
||
*/
|
||
HopObject.prototype.getTags = function() {
|
||
var tags = [];
|
||
if (typeof this.tags === "object") {
|
||
this.tags.list().forEach(function(item) {
|
||
item.tag && tags.push(item.tag.name);
|
||
});
|
||
}
|
||
return tags;
|
||
}
|
||
|
||
/**
|
||
*
|
||
* @param {Tag[]|String} tags
|
||
*/
|
||
HopObject.prototype.setTags = function(tags) {
|
||
if (typeof this.tags !== "object") {
|
||
return String.EMPTY;
|
||
}
|
||
|
||
if (!tags) {
|
||
tags = [];
|
||
} else if (tags.constructor === String) {
|
||
tags = tags.split(/\s*,\s*/);
|
||
}
|
||
|
||
var diff = {};
|
||
var tag;
|
||
for (var i in tags) {
|
||
// Trim and remove troublesome characters (like ../.. etc.)
|
||
// We call getAccessName with a virgin HopObject to allow most names
|
||
tag = tags[i] = this.getAccessName.call(new HopObject, File.getName(tags[i]));
|
||
if (tag && diff[tag] == null) {
|
||
diff[tag] = 1;
|
||
}
|
||
}
|
||
this.tags.forEach(function() {
|
||
if (!this.tag) {
|
||
return;
|
||
}
|
||
diff[this.tag.name] = (tags.indexOf(this.tag.name) < 0) ? this : 0;
|
||
});
|
||
|
||
for (var tag in diff) {
|
||
switch (diff[tag]) {
|
||
case 0:
|
||
// Do nothing (tag already exists)
|
||
break;
|
||
case 1:
|
||
// Add tag to story
|
||
this.addTag(tag);
|
||
break;
|
||
default:
|
||
// Remove tag
|
||
this.removeTag(diff[tag]);
|
||
}
|
||
}
|
||
return;
|
||
}
|
||
|
||
/**
|
||
*
|
||
* @param {String} name
|
||
*/
|
||
HopObject.prototype.addTag = function(name) {
|
||
this.tags.add(new TagHub(name, this, session.user));
|
||
return;
|
||
}
|
||
|
||
/**
|
||
*
|
||
* @param {String} tag
|
||
*/
|
||
HopObject.prototype.removeTag = function(tag) {
|
||
var parent = tag._parent;
|
||
if (parent.size() === 1) {
|
||
parent.remove();
|
||
}
|
||
tag.remove();
|
||
return;
|
||
}
|
||
|
||
/**
|
||
*
|
||
* @param {Object} param
|
||
* @param {String} name
|
||
*/
|
||
HopObject.prototype.skin_macro = function(param, name) {
|
||
if (!name) {
|
||
return;
|
||
}
|
||
if (name.contains("#")) {
|
||
this.renderSkin(name);
|
||
} else {
|
||
var prototype = this._prototype || "Global";
|
||
this.renderSkin(prototype + "#" + name);
|
||
}
|
||
return;
|
||
}
|
||
|
||
/**
|
||
*
|
||
* @param {Object} param
|
||
* @param {String} name
|
||
*/
|
||
HopObject.prototype.input_macro = function(param, name) {
|
||
param.name = name;
|
||
param.id = name;
|
||
param.value = this.getFormValue(name);
|
||
return html.input(param);
|
||
}
|
||
|
||
/**
|
||
*
|
||
* @param {Object} param
|
||
* @param {String} name
|
||
*/
|
||
HopObject.prototype.textarea_macro = function(param, name) {
|
||
param.name = name;
|
||
param.id = name;
|
||
param.value = this.getFormValue(name);
|
||
return html.textArea(param);
|
||
}
|
||
|
||
/**
|
||
*
|
||
* @param {Object} param
|
||
* @param {String} name
|
||
*/
|
||
HopObject.prototype.select_macro = function(param, name) {
|
||
param.name = name;
|
||
param.id = name;
|
||
var options = this.getFormOptions(name);
|
||
if (options.length < 2) {
|
||
param.disabled = "disabled";
|
||
}
|
||
return html.dropDown(param, options, this.getFormValue(name));
|
||
}
|
||
|
||
/**
|
||
*
|
||
* @param {Object} param
|
||
* @param {String} name
|
||
*/
|
||
HopObject.prototype.checkbox_macro = function(param, name) {
|
||
param.name = name;
|
||
param.id = name;
|
||
var options = this.getFormOptions(name);
|
||
if (options.length < 2) {
|
||
param.disabled = "disabled";
|
||
}
|
||
param.value = String((options[1] || options[0]).value);
|
||
param.selectedValue = String(this.getFormValue(name));
|
||
var label = param.label;
|
||
delete param.label;
|
||
html.checkBox(param);
|
||
if (label) {
|
||
html.element("label", label, {"for": name});
|
||
}
|
||
return;
|
||
}
|
||
|
||
/**
|
||
*
|
||
* @param {Object} param
|
||
* @param {String} name
|
||
*/
|
||
HopObject.prototype.radiobutton_macro = function(param, name) {
|
||
param.name = name;
|
||
param.id = name;
|
||
var options = this.getFormOptions(name);
|
||
if (options.length < 2) {
|
||
param.disabled = "disabled";
|
||
}
|
||
param.value = String(options[0].value);
|
||
param.selectedValue = String(this.getFormValue(name));
|
||
var label = param.label;
|
||
delete param.label;
|
||
html.radioButton(param);
|
||
if (label) {
|
||
html.element("label", label, {"for": name});
|
||
}
|
||
return;
|
||
}
|
||
|
||
/**
|
||
*
|
||
* @param {Object} param
|
||
* @param {String} name
|
||
*/
|
||
HopObject.prototype.upload_macro = function(param, name) {
|
||
param.name = name;
|
||
param.id = name;
|
||
param.value = this.getFormValue(name);
|
||
renderSkin("$Global#upload", param);
|
||
return;
|
||
}
|
||
|
||
/**
|
||
*
|
||
* @param {Object} param
|
||
* @param {HopObject} [handler]
|
||
*/
|
||
HopObject.prototype.macro_macro = function(param, handler) {
|
||
var ctor = this.constructor;
|
||
if ([Story, Image, File, Poll].indexOf(ctor) > -1) {
|
||
res.write('<span class="macro-code">');
|
||
res.encode("<% ");
|
||
res.write(handler || ctor.name.toLowerCase());
|
||
res.write(String.SPACE);
|
||
res.write(quote(this.name || this._id));
|
||
res.encode(" %>");
|
||
res.write('</span>');
|
||
}
|
||
return;
|
||
}
|
||
|
||
/**
|
||
*
|
||
*/
|
||
HopObject.prototype.kind_macro = function() {
|
||
var type = this.constructor.name.toLowerCase();
|
||
switch (type) {
|
||
default:
|
||
res.write(gettext(type));
|
||
break;
|
||
}
|
||
return;
|
||
}
|
||
|
||
/**
|
||
*
|
||
* @param {String} name
|
||
* @returns {Number|String}
|
||
*/
|
||
HopObject.prototype.getFormValue = function(name) {
|
||
if (req.isPost()) {
|
||
return req.postParams[name];
|
||
} else {
|
||
var value = this[name] || req.queryParams[name] || String.EMPTY;
|
||
return value instanceof HopObject ? value._id : value;
|
||
}
|
||
}
|
||
|
||
/**
|
||
* @returns {Object[]}
|
||
*/
|
||
HopObject.prototype.getFormOptions = function() {
|
||
return [{value: true, display: "enabled"}];
|
||
}
|
||
|
||
/**
|
||
* @returns {HopObject}
|
||
* @param {Object} param
|
||
* @param {String} property
|
||
*/
|
||
HopObject.prototype.self_macro = function(param, property) {
|
||
return property ? this[property] : this;
|
||
}
|
||
|
||
/**
|
||
*
|
||
*/
|
||
HopObject.prototype.type_macro = function() {
|
||
return res.write(this.constructor.name);
|
||
}
|
||
|
||
/**
|
||
*
|
||
* @param {Object} param
|
||
* @param {String} url
|
||
* @param {String} text
|
||
*/
|
||
HopObject.prototype.link_macro = function(param, url, text) {
|
||
if (url && text) {
|
||
var action = url.split(/#|\?/)[0];
|
||
if (this.getPermission(action)) {
|
||
renderLink.call(global, param, url, text, this);
|
||
}
|
||
} else {
|
||
res.write("[Insufficient link parameters]");
|
||
}
|
||
return;
|
||
}
|
||
|
||
/**
|
||
*
|
||
* @param {Object} param
|
||
* @param {String} format
|
||
*/
|
||
HopObject.prototype.created_macro = function(param, format) {
|
||
if (this.isPersistent()) {
|
||
format || (format = param.format);
|
||
res.write(formatDate(this.created, format));
|
||
}
|
||
return;
|
||
}
|
||
|
||
/**
|
||
*
|
||
* @param {Object} param
|
||
* @param {String} format
|
||
*/
|
||
HopObject.prototype.modified_macro = function(param, format) {
|
||
if (this.isPersistent()) {
|
||
format || (format = param.format);
|
||
res.write(formatDate(this.modified, format));
|
||
}
|
||
return;
|
||
}
|
||
|
||
/**
|
||
*
|
||
* @param {Object} param
|
||
* @param {String} mode
|
||
*/
|
||
HopObject.prototype.creator_macro = function(param, mode) {
|
||
if (!this.creator || this.isTransient()) {
|
||
return;
|
||
}
|
||
mode || (mode = param.as);
|
||
if (mode === "link" && this.creator.url) {
|
||
html.link({href: this.creator.url}, this.creator.name);
|
||
} else if (mode === "url") {
|
||
res.write(this.creator.url);
|
||
} else {
|
||
res.write(this.creator.name);
|
||
} return;
|
||
}
|
||
|
||
/**
|
||
*
|
||
* @param {Object} param
|
||
* @param {String} mode
|
||
*/
|
||
HopObject.prototype.modifier_macro = function(param, mode) {
|
||
if (!this.modifier || this.isTransient()) {
|
||
return;
|
||
}
|
||
mode || (mode = param.as);
|
||
if (mode === "link" && this.modifier.url) {
|
||
html.link({href: this.modifier.url}, this.modifier.name);
|
||
} else if (mode === "url") {
|
||
res.write(this.modifier.url);
|
||
} else {
|
||
res.write(this.modifier.name);
|
||
}
|
||
return;
|
||
}
|
||
|
||
/**
|
||
* @returns {String}
|
||
*/
|
||
HopObject.prototype.getTitle = function() {
|
||
return this.title || gettext(this.__name__.capitalize());
|
||
}
|
||
|
||
/**
|
||
* @returns {String}
|
||
*/
|
||
HopObject.prototype.toString = function() {
|
||
return this.constructor.name + " #" + this._id;
|
||
}
|
||
|
||
/**
|
||
*
|
||
* @param {String} text
|
||
* @param {Object} param
|
||
* @param {String} action
|
||
* @returns {String}
|
||
*/
|
||
HopObject.prototype.link_filter = function(text, param, action) {
|
||
action || (action = ".");
|
||
res.push();
|
||
renderLink(param, action, text, this);
|
||
return res.pop();
|
||
}
|