Tobi Schäfer
1b8bf37675
* Slightly increased sizes of some input elements for convenience * Added SQL patch updating constraints of the membership role column (MySQL) * Removed obsolete title and description properties from Layout * Minor layout enhancements and wording edits
459 lines
11 KiB
JavaScript
459 lines
11 KiB
JavaScript
//
|
|
// The Antville Project
|
|
// http://code.google.com/p/antville
|
|
//
|
|
// Copyright 2001-2007 by The Antville People
|
|
//
|
|
// 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$
|
|
// $LastChangedBy$
|
|
// $LastChangedDate$
|
|
// $URL$
|
|
//
|
|
|
|
/**
|
|
* @fileOverview Defines the Layout prototype
|
|
*/
|
|
|
|
/** @constant */
|
|
Layout.VALUES = [
|
|
"background color",
|
|
"link color",
|
|
"active link color",
|
|
"visited link color",
|
|
"big font",
|
|
"big font size",
|
|
"big font color",
|
|
"base font",
|
|
"base font size",
|
|
"base font color",
|
|
"small font",
|
|
"small font size",
|
|
"small font color"
|
|
];
|
|
|
|
/**
|
|
*
|
|
* @param {Layout} layout
|
|
* @param {Boolean} includeSelf
|
|
*/
|
|
Layout.remove = function(options) {
|
|
if (this.constructor === Layout) {
|
|
// Backup current layout in temporary directory if possible
|
|
var dir = this.getFile();
|
|
if (res.skinpath && res.skinpath[0].equals(dir) &&
|
|
dir.exists() && dir.list().length > 0) {
|
|
var zip = this.getArchive(res.skinpath);
|
|
var file = java.io.File.createTempFile(this.site.name + "-layout-", ".zip");
|
|
zip.save(file);
|
|
}
|
|
HopObject.remove.call(this.skins);
|
|
HopObject.remove.call(this.images);
|
|
this.getFile().removeDirectory();
|
|
// The “force” flag is set e.g. when a whole site is removed
|
|
options && options.force && this.remove();
|
|
}
|
|
return;
|
|
}
|
|
|
|
/**
|
|
* @function
|
|
* @returns {String[]}
|
|
* @see defineConstants
|
|
*/
|
|
Layout.getModes = defineConstants(Layout, "default", "shared");
|
|
|
|
this.handleMetadata("origin");
|
|
this.handleMetadata("originator");
|
|
this.handleMetadata("originated");
|
|
|
|
/**
|
|
* @name Layout
|
|
* @constructor
|
|
* @param {Site} site
|
|
* @property {Date} created
|
|
* @property {User} creator
|
|
* @property {Images} images
|
|
* @property {Metadata} metadata
|
|
* @property {String} mode
|
|
* @property {Date} modified
|
|
* @property {User} modifier
|
|
* @property {String} origin
|
|
* @property {String} originator
|
|
* @property {Date} originated
|
|
* @property {Site} site
|
|
* @property {Skins} skins
|
|
* @extends HopObject
|
|
*/
|
|
Layout.prototype.constructor = function(site) {
|
|
this.site = site;
|
|
this.creator = session.user;
|
|
this.created = new Date;
|
|
this.mode = Layout.DEFAULT;
|
|
this.touch();
|
|
return this;
|
|
}
|
|
|
|
/**
|
|
*
|
|
* @param {String} action
|
|
* @returns {Boolean}
|
|
*/
|
|
Layout.prototype.getPermission = function(action) {
|
|
switch (action) {
|
|
case ".":
|
|
case "main":
|
|
case "export":
|
|
case "images":
|
|
case "import":
|
|
case "reset":
|
|
case "skins":
|
|
return res.handlers.site.getPermission("main") &&
|
|
Membership.require(Membership.OWNER) ||
|
|
User.require(User.PRIVILEGED);
|
|
}
|
|
return false;
|
|
}
|
|
|
|
// FIXME: The Layout.href method is overwritten to guarantee that
|
|
// URLs won't contain the layout ID instead of "layout"
|
|
/**
|
|
*
|
|
* @param {String} action
|
|
* @returns {String}
|
|
*/
|
|
Layout.prototype.href = function(action) {
|
|
res.push();
|
|
res.write(res.handlers.site.href());
|
|
res.write("layout/");
|
|
action && res.write(action);
|
|
return res.pop();
|
|
}
|
|
|
|
Layout.prototype.main_action = function() {
|
|
if (req.postParams.save) {
|
|
try {
|
|
this.update(req.postParams);
|
|
res.message = gettext("Successfully updated the layout.");
|
|
res.redirect(this.href());
|
|
} catch (ex) {
|
|
res.message = ex;
|
|
app.log(ex);
|
|
}
|
|
}
|
|
res.data.title = gettext("Layout");
|
|
res.data.body = this.renderSkinAsString("$Layout#main");
|
|
res.handlers.site.renderSkin("Site#page");
|
|
return;
|
|
}
|
|
|
|
/**
|
|
*
|
|
* @param {String} name
|
|
* @returns {Object}
|
|
*/
|
|
Layout.prototype.getFormOptions = function(name) {
|
|
switch (name) {
|
|
case "mode":
|
|
return Layout.getModes();
|
|
case "parent":
|
|
return this.getParentOptions();
|
|
}
|
|
}
|
|
|
|
/**
|
|
*
|
|
* @param {Object} data
|
|
*/
|
|
Layout.prototype.update = function(data) {
|
|
var skin = this.skins.getSkin("Site", "values");
|
|
if (!skin) {
|
|
skin = new Skin("Site", "values");
|
|
this.skins.add(skin);
|
|
}
|
|
res.push();
|
|
for (var key in data) {
|
|
if (key.startsWith("value_")) {
|
|
var value = data[key];
|
|
key = key.substr(6);
|
|
res.write("<% value ");
|
|
res.write(quote(key));
|
|
res.write(" ");
|
|
res.write(quote(value));
|
|
res.write(" %>\n");
|
|
}
|
|
}
|
|
res.write("\n");
|
|
skin.setSource(res.pop());
|
|
this.description = data.description;
|
|
this.mode = data.mode;
|
|
this.touch();
|
|
return;
|
|
}
|
|
|
|
Layout.prototype.reset_action = function() {
|
|
if (req.data.proceed) {
|
|
try {
|
|
Layout.remove.call(this);
|
|
this.reset();
|
|
res.message = gettext("The layout was successfully reset.");
|
|
res.redirect(this.href());
|
|
} catch(ex) {
|
|
res.message = ex;
|
|
app.log(ex);
|
|
}
|
|
}
|
|
|
|
res.data.action = this.href(req.action);
|
|
res.data.title = gettext("Confirm Reset");
|
|
res.data.body = this.renderSkinAsString("$HopObject#confirm", {
|
|
text: this.getConfirmText()
|
|
});
|
|
res.handlers.site.renderSkin("Site#page");
|
|
}
|
|
|
|
Layout.prototype.export_action = function() {
|
|
res.contentType = "application/zip";
|
|
var zip = this.getArchive(res.skinpath);
|
|
res.setHeader("Content-Disposition",
|
|
"attachment; filename=" + this.site.name + "-layout.zip");
|
|
res.writeBinary(zip.getData());
|
|
return;
|
|
}
|
|
|
|
Layout.prototype.import_action = function() {
|
|
var self = this;
|
|
var data = req.postParams;
|
|
if (data.submit) {
|
|
try {
|
|
if (!data.upload || data.upload.contentLength === 0) {
|
|
throw Error(gettext("Please upload a zipped layout archive"));
|
|
}
|
|
// Extract zipped layout to temporary directory
|
|
var dir = this.site.getStaticFile();
|
|
var temp = new helma.File(dir, "import.temp");
|
|
var fname = data.upload.writeToFile(dir);
|
|
var zip = new helma.File(dir, fname);
|
|
(new helma.Zip(zip)).extractAll(temp);
|
|
zip.remove();
|
|
var data = Xml.read(new helma.File(temp, "data.xml"));
|
|
if (!data.version || data.version !== Root.VERSION) {
|
|
throw Error(gettext("Sorry, this layout is not compatible with Antville."));
|
|
}
|
|
// Remove current layout and replace it with imported one
|
|
Layout.remove.call(this);
|
|
temp.renameTo(this.getFile());
|
|
this.origin = data.origin;
|
|
this.originator = data.originator;
|
|
this.originated = data.originated;
|
|
data.images.forEach(function() {
|
|
self.images.add(new Image(this));
|
|
});
|
|
this.touch();
|
|
res.message = gettext("The layout was successfully imported.");
|
|
} catch (ex) {
|
|
res.message = ex;
|
|
app.log(ex);
|
|
temp.removeDirectory();
|
|
res.redirect(this.href(req.action));
|
|
}
|
|
res.redirect(this.href());
|
|
return;
|
|
}
|
|
res.data.title = gettext("Import Layout");
|
|
res.data.body = this.renderSkinAsString("$Layout#import");
|
|
res.handlers.site.renderSkin("Site#page");
|
|
return;
|
|
}
|
|
|
|
/**
|
|
*
|
|
* @param {String} name
|
|
* @param {String} fallback
|
|
* @returns {Image}
|
|
*/
|
|
Layout.prototype.getImage = function(name, fallback) {
|
|
var layout = this;
|
|
while (layout) {
|
|
if (layout.images.get(name)) {
|
|
return layout.images.get(name);
|
|
}
|
|
if (fallback && layout.images.get(fallback)) {
|
|
return layout.images.get(fallback);
|
|
}
|
|
layout = layout.parent;
|
|
}
|
|
return null;
|
|
}
|
|
|
|
/**
|
|
*
|
|
* @param {String} name
|
|
* @returns {helma.File}
|
|
*/
|
|
Layout.prototype.getFile = function(name) {
|
|
name || (name = String.EMPTY);
|
|
return this.site.getStaticFile("layout/" + name);
|
|
}
|
|
|
|
/**
|
|
* @returns {String[]}
|
|
*/
|
|
Layout.prototype.getSkinPath = function() {
|
|
if (!this.site) {
|
|
return null;
|
|
}
|
|
var skinPath = [this.getFile().toString()];
|
|
return skinPath;
|
|
}
|
|
|
|
/**
|
|
*
|
|
*/
|
|
Layout.prototype.reset = function() {
|
|
var skinFiles = app.getSkinfilesInPath([app.dir]);
|
|
var content, file;
|
|
for (var name in skinFiles) {
|
|
if (content = skinFiles[name][name]) {
|
|
var dir = this.getFile(name);
|
|
var file = new helma.File(dir, name + ".skin");
|
|
dir.makeDirectory();
|
|
file.open();
|
|
file.write(content);
|
|
file.close();
|
|
}
|
|
}
|
|
this.touch();
|
|
return;
|
|
}
|
|
|
|
/**
|
|
*
|
|
* @param {String} skinPath
|
|
* @returns {helma.Zip}
|
|
*/
|
|
Layout.prototype.getArchive = function(skinPath) {
|
|
var zip = new helma.Zip();
|
|
var skinFiles = app.getSkinfilesInPath(skinPath);
|
|
for (var name in skinFiles) {
|
|
if (skinFiles[name][name]) {
|
|
var file = new helma.File(this.getFile(name), name + ".skin");
|
|
if (file.exists()) {
|
|
zip.add(file, name);
|
|
}
|
|
}
|
|
}
|
|
|
|
var data = new HopObject;
|
|
data.images = new HopObject;
|
|
this.images.forEach(function() {
|
|
zip.add(this.getFile());
|
|
try {
|
|
zip.add(this.getThumbnailFile());
|
|
} catch (ex) {
|
|
/* Most likely the thumbnail file is identical to the image */
|
|
}
|
|
var image = new HopObject;
|
|
for each (var key in Image.KEYS) {
|
|
image[key] = this[key];
|
|
data.images.add(image);
|
|
}
|
|
});
|
|
|
|
data.version = Root.VERSION;
|
|
data.origin = this.origin || this.site.href();
|
|
data.originator = this.originator || session.user.name;
|
|
data.originated = this.originated || new Date;
|
|
|
|
// FIXME: XML encoder is losing all mixed-case properties :(
|
|
var xml = new java.lang.String(Xml.writeToString(data));
|
|
zip.addData(xml.getBytes("UTF-8"), "data.xml");
|
|
zip.close();
|
|
return zip;
|
|
}
|
|
|
|
|
|
/**
|
|
* @returns {String}
|
|
*/
|
|
Layout.prototype.getConfirmText = function() {
|
|
return gettext("You are about to reset the layout of site {0}.",
|
|
this.site.name);
|
|
}
|
|
/**
|
|
*
|
|
* @param {String} name
|
|
* @returns {HopObject}
|
|
*/
|
|
Layout.prototype.getMacroHandler = function(name) {
|
|
switch (name) {
|
|
case "skins":
|
|
return this[name];
|
|
|
|
default:
|
|
return null;
|
|
}
|
|
}
|
|
|
|
/**
|
|
*
|
|
* @param {Object} param
|
|
* @param {String} name
|
|
* @param {String} mode
|
|
*/
|
|
Layout.prototype.image_macro = function(param, name, mode) {
|
|
name || (name = param.name);
|
|
if (!name) {
|
|
return;
|
|
}
|
|
|
|
var image = this.getImage(name, param.fallback);
|
|
if (!image) {
|
|
return;
|
|
}
|
|
|
|
mode || (mode = param.as);
|
|
var action = param.linkto;
|
|
delete(param.name);
|
|
delete(param.as);
|
|
delete(param.linkto);
|
|
|
|
switch (mode) {
|
|
case "url" :
|
|
return res.write(image.getUrl());
|
|
case "thumbnail" :
|
|
action || (action = image.getUrl());
|
|
return image.thumbnail_macro(param);
|
|
}
|
|
image.render_macro(param);
|
|
return;
|
|
}
|
|
|
|
/**
|
|
*
|
|
*/
|
|
Layout.prototype.values_macro = function() {
|
|
var values = [];
|
|
for (var key in res.meta.values) {
|
|
values.push({key: key, value: res.meta.values[key]});
|
|
}
|
|
values.sort(new String.Sorter("key"));
|
|
for each (var pair in values) {
|
|
this.renderSkin("$Layout#value", {
|
|
key: pair.key.capitalize(),
|
|
value: pair.value
|
|
});
|
|
}
|
|
return;
|
|
}
|