settings/js/admin-apps.js
/* global Handlebars */
Handlebars.registerHelper('score', function() {
if(this.score) {
var score = Math.round( this.score / 10 );
var imageName = 'rating/s' + score + '.svg';
return new Handlebars.SafeString('<img src="' + OC.imagePath('core', imageName) + '">');
}
return new Handlebars.SafeString('');
});
Handlebars.registerHelper('level', function() {
if(!_.isUndefined(this.level)) {
if(this.level === 200) {
return new Handlebars.SafeString('<span class="official icon-checkmark">' + t('settings', 'Official') + '</span>');
} else if(this.level === 100) {
return new Handlebars.SafeString('<span class="approved">' + t('settings', 'Approved') + '</span>');
}
}
});
Handlebars.registerHelper('md', function(text){
var converter = new showdown.Converter({
strikethrough: true,
tables : true,
tasklists : true
});
return new Handlebars.SafeString(
converter.makeHtml(text)
);
});
OC.Settings = OC.Settings || {};
OC.Settings.Apps = OC.Settings.Apps || {
setupGroupsSelect: function($elements) {
OC.Settings.setupGroupsSelect($elements, {
placeholder: t('settings', 'All')
});
},
State: {
currentCategory: null,
apps: null
},
loadCategories: function() {
var categories = [
{displayName: t('settings', 'Enabled'), ident: 'enabled', id: '0'},
{displayName: t('settings', 'Not enabled'), ident: 'disabled', id: '1'}
];
var source = $("#categories-template").html();
var template = Handlebars.compile(source);
var html = template(categories);
$('#apps-categories').html(html);
var queries = {
category: 'enabled'
};
if (document.location.search) {
$.each(document.location.search.substr(1).split('&'), function (c, q) {
var i = q.split('=');
queries[i[0].toString()] = i[1].toString();
});
}
OC.Settings.Apps.loadCategory(queries.category);
},
loadCategory: function(categoryId) {
var self = this;
if (OC.Settings.Apps.State.currentCategory === categoryId) {
return;
}
if (this._loadCategoryCall) {
this._loadCategoryCall.abort();
}
$('#apps-list')
.addClass('icon-loading')
.removeClass('hidden')
.html('');
$('#apps-list-empty').addClass('hidden');
$('#button-apps-enabled').hide();
$('#button-apps-disabled').hide();
OC.Settings.Apps.State.currentCategory = categoryId;
this._loading = true;
this._loadCategoryCall = $.ajax(OC.generateUrl('settings/apps/list?category={categoryId}', {
categoryId: categoryId
}), {
type:'GET',
success: function (apps) {
var appListWithIndex = _.indexBy(apps.apps, 'id');
OC.Settings.Apps.State.apps = appListWithIndex;
var appList = _.map(appListWithIndex, function(app) {
// default values for missing fields
return _.extend({level: 0}, app);
});
var source = $("#app-template").html();
var template = Handlebars.compile(source);
if (appList.length) {
appList.sort(function(a,b) {
var levelDiff = b.level - a.level;
if (levelDiff === 0) {
return OC.Util.naturalSortCompare(a.name, b.name);
}
return levelDiff;
});
var firstExperimental = false;
_.each(appList, function(app) {
if(app.level === 0 && firstExperimental === false) {
firstExperimental = true;
OC.Settings.Apps.renderApp(app, template, null, true);
} else {
OC.Settings.Apps.renderApp(app, template, null, false);
}
});
} else {
$('#apps-list').addClass('hidden');
$('#apps-list-empty').removeClass('hidden').find('h2').text(t('settings', 'No apps found for your version'));
}
$('.enable.needs-download').tooltip({title: t('settings', 'The app will be downloaded from the app store'), container: 'body'});
$('.app-level .official').tooltip({title: t('settings', 'Official apps are developed by and within the ownCloud community. They offer functionality central to ownCloud and are ready for production use.'), container: 'body'});
$('.app-level .approved').tooltip({title: t('settings', 'Approved apps are developed by trusted developers and have passed a cursory security check. They are actively maintained in an open code repository and their maintainers deem them to be stable for casual to normal use.'), container: 'body'});
$('.app-level .experimental').tooltip({title: t('settings', 'This app is not checked for security issues and is new or known to be unstable. Install at your own risk.'), container: 'body'});
},
complete: function() {
$('#apps-list').removeClass('icon-loading');
$('#button-apps-' + (OC.Settings.Apps.State.currentCategory === 'enabled' ? 'disabled' : 'enabled')).show();
}
});
this._loadCategoryCall.always(function() {
self._loading = false;
if (self._filterQuery) {
// re-set filter
self.filter(self._filterQuery);
}
});
return this._loadCategoryCall;
},
renderApp: function(app, template, selector, firstExperimental) {
if (!template) {
var source = $("#app-template").html();
template = Handlebars.compile(source);
}
if (_.isString(app)) {
app = OC.Settings.Apps.State.apps[app];
}
app.firstExperimental = firstExperimental;
if (!app.preview) {
app.preview = OC.imagePath('core', 'default-app-icon');
app.previewAsIcon = true;
}
app.author = this._parseAppAuthor(app.author);
var html = template(app);
if (selector) {
selector.html(html);
} else {
$('#apps-list').append(html);
}
var page = $('#app-' + app.id);
// image loading kung-fu (IE doesn't properly scale SVGs, so disable app icons)
if (app.preview && !OC.Util.isIE()) {
var currentImage = new Image();
currentImage.src = app.preview;
currentImage.onload = function() {
page.find('.app-image')
.append(this)
.fadeIn();
};
}
// set group select properly
if (OC.Settings.Apps.isProtected(app)) {
page.find(".groups-enable").hide();
page.find(".groups-enable__checkbox").prop('checked', false);
} else {
page.find('#group_select').val((app.groups || []).join('|'));
if (app.active) {
if (app.groups.length) {
OC.Settings.Apps.setupGroupsSelect(page.find('#group_select'));
page.find(".groups-enable__checkbox").prop('checked', true);
} else {
page.find(".groups-enable__checkbox").prop('checked', false);
}
page.find(".groups-enable").show();
} else {
page.find(".groups-enable").hide();
}
}
},
/**
* Parses the author(s) from the app info response.
*
* @param {(string|string[]|Object|Object[])} author - A string or an array of Objects or strings or both representing the author info from apps info.xml.
* @return {string}
*/
_parseAppAuthor: function (author) {
if (_.isObject(author) && !_.isUndefined(author['@value'])) {
return author['@value'];
}
if (_.isArray(author)) {
var authorNames = [];
for (var i = 0; i < author.length; i++) {
if (_.isObject(author[i]) && !_.isUndefined(author[i]['@value'])) {
authorNames.push(author[i]['@value']);
} else {
authorNames.push(author[i]);
}
}
return authorNames.join(', ');
}
return author;
},
/**
* Checks if enable for groups should be hidden
* @param app
* @returns {boolean}
*/
isProtected: function(app) {
var protectedTypes = [
'filesystem',
'prelogin',
'authentication',
'logging',
'prevent_group_restriction',
'theme'
];
for (var i=0;i<protectedTypes.length;i++) {
if (OC.Settings.Apps.isType(app, protectedTypes[i])) {
return true;
}
}
return false;
},
isType: function(app, type) {
return app.types && app.types.indexOf(type) !== -1;
},
/**
* Checks the server health.
*
* If the promise fails, the server is broken.
*
* @return {Promise} promise
*/
_checkServerHealth: function() {
return $.get(OC.generateUrl('apps/files'));
},
enableApp:function(appId, active, element, groups) {
var self = this;
OC.Settings.Apps.hideErrorMessage(appId);
groups = groups || [];
var appItem = $('div#app-'+appId+'');
element.val(t('settings','Please wait....'));
if(active && !groups.length) {
$.post(OC.filePath('settings','ajax','disableapp.php'),{appid:appId},function(result) {
if(!result || result.status !== 'success') {
if (result.data && result.data.message) {
OC.Settings.Apps.showErrorMessage(appId, result.data.message);
appItem.data('errormsg', result.data.message);
} else {
OC.Settings.Apps.showErrorMessage(appId, t('settings', 'Error while disabling app'));
appItem.data('errormsg', t('settings', 'Error while disabling app'));
}
element.val(t('settings','Disable'));
appItem.addClass('appwarning');
} else {
OC.Settings.Apps.rebuildNavigation();
appItem.data('active',false);
appItem.data('groups', '');
element.data('active',false);
appItem.removeClass('active');
element.val(t('settings','Enable'));
element.parent().find(".groups-enable").hide();
element.parent().find('#group_select').hide().val(null);
OC.Settings.Apps.State.apps[appId].active = false;
}
},'json');
} else {
// TODO: display message to admin to not refresh the page!
// TODO: lock UI to prevent further operations
$.post(OC.filePath('settings','ajax','enableapp.php'),{appid: appId, groups: groups},function(result) {
if(!result || result.status !== 'success') {
if (result.data && result.data.message) {
OC.Settings.Apps.showErrorMessage(appId, result.data.message);
appItem.data('errormsg', result.data.message);
} else {
OC.Settings.Apps.showErrorMessage(appId, t('settings', 'Error while enabling app'));
appItem.data('errormsg', t('settings', 'Error while disabling app'));
}
element.val(t('settings','Enable'));
appItem.addClass('appwarning');
} else {
self._checkServerHealth().done(function() {
if (result.data.update_required) {
OC.Settings.Apps.showReloadMessage();
setTimeout(function() {
location.reload();
}, 5000);
}
OC.Settings.Apps.rebuildNavigation();
appItem.data('active',true);
element.data('active',true);
appItem.addClass('active');
element.val(t('settings','Disable'));
var app = OC.Settings.Apps.State.apps[appId];
app.active = true;
if (OC.Settings.Apps.isType(app, 'filesystem') || OC.Settings.Apps.isType(app, 'prelogin') ||
OC.Settings.Apps.isType(app, 'authentication') || OC.Settings.Apps.isType(app, 'logging')) {
element.parent().find(".groups-enable").prop('checked', true);
element.parent().find(".groups-enable").hide();
element.parent().find('#group_select').hide().val(null);
} else {
element.parent().find("#groups-enable").show();
if (groups) {
appItem.data('groups', JSON.stringify(groups));
} else {
appItem.data('groups', '');
}
}
}).fail(function() {
// server borked, emergency disable app
$.post(OC.webroot + '/index.php/disableapp', {appid: appId}, function() {
OC.Settings.Apps.showErrorMessage(
appId,
t('settings', 'Error: this app cannot be enabled because it makes the server unstable')
);
appItem.data('errormsg', t('settings', 'Error while enabling app'));
element.val(t('settings','Enable'));
appItem.addClass('appwarning');
}).fail(function() {
OC.Settings.Apps.showErrorMessage(
appId,
t('settings', 'Error: could not disable broken app')
);
appItem.data('errormsg', t('settings', 'Error while disabling broken app'));
element.val(t('settings','Enable'));
});
});
}
},'json')
.fail(function() {
OC.Settings.Apps.showErrorMessage(appId, t('settings', 'Error while enabling app'));
appItem.data('errormsg', t('settings', 'Error while enabling app'));
appItem.data('active',false);
appItem.addClass('appwarning');
element.val(t('settings','Enable'));
});
}
},
updateApp:function(appId, element) {
var oldButtonText = element.val();
element.val(t('settings','Updating....'));
OC.Settings.Apps.hideErrorMessage(appId);
$.post(OC.filePath('settings','ajax','updateapp.php'),{appid:appId},function(result) {
if(!result || result.status !== 'success') {
if (result.data && result.data.message) {
OC.Settings.Apps.showErrorMessage(appId, result.data.message);
} else {
OC.Settings.Apps.showErrorMessage(appId, t('settings','Error while updating app'));
}
element.val(oldButtonText);
}
else {
element.val(t('settings','Updated'));
element.hide();
}
},'json');
},
uninstallApp:function(appId, element) {
OC.Settings.Apps.hideErrorMessage(appId);
element.val(t('settings','Uninstalling ....'));
$.post(OC.filePath('settings','ajax','uninstallapp.php'),{appid:appId},function(result) {
if(!result || result.status !== 'success') {
OC.Settings.Apps.showErrorMessage(appId, t('settings','Error while uninstalling app'));
element.val(t('settings','Uninstall'));
} else {
OC.Settings.Apps.rebuildNavigation();
element.parent().fadeOut(function() {
element.remove();
});
}
},'json');
},
rebuildNavigation: function() {
$.getJSON(OC.filePath('settings', 'ajax', 'navigationdetect.php')).done(function(response){
if(response.status === 'success'){
var idsToKeep = {};
var navEntries=response.nav_entries;
var container = $('#apps ul');
for(var i=0; i< navEntries.length; i++){
var entry = navEntries[i];
idsToKeep[entry.id] = true;
if(container.children('li[data-id="'+entry.id+'"]').length === 0){
var li=$('<li></li>');
li.attr('data-id', entry.id);
var img= $('<img class="app-icon"/>').attr({ src: entry.icon});
var a=$('<a></a>').attr('href', entry.href);
var filename=$('<span></span>');
var loading = $('<div class="icon-loading-dark"></div>').css('display', 'none');
filename.text(entry.name);
a.prepend(filename);
a.prepend(loading);
a.prepend(img);
li.append(a);
// append the new app as last item in the list
// which is the "add apps" entry with the id
// #apps-management
$('#apps-management').before(li);
// scroll the app navigation down
// so the newly added app is seen
$('#navigation').animate({
scrollTop: $('#navigation').height()
}, 'slow');
// draw attention to the newly added app entry
// by flashing it twice
$('#header .menutoggle')
.animate({opacity: 0.5})
.animate({opacity: 1})
.animate({opacity: 0.5})
.animate({opacity: 1})
.animate({opacity: 0.75});
if (!OC.Util.hasSVGSupport() && entry.icon.match(/\.svg$/i)) {
$(img).addClass('svg');
OC.Util.replaceSVG();
}
}
}
container.children('li[data-id]').each(function(index, el) {
if (!idsToKeep[$(el).data('id')]) {
$(el).remove();
}
});
}
});
},
showErrorMessage: function(appId, message) {
$('div#app-'+appId+' .warning')
.show()
.text(message);
},
hideErrorMessage: function(appId) {
$('div#app-'+appId+' .warning')
.hide()
.text('');
},
showReloadMessage: function() {
OC.dialogs.info(
t(
'settings',
'The app has been enabled but needs to be updated. You will be redirected to the update page in 5 seconds.'
),
t('settings','App update'),
function () {
window.location.reload();
},
true
);
},
filter: function(query) {
// FIXME: the caller doesn't properly set the "this" context
var self = OC.Settings.Apps;
self._filterQuery = query;
var $appList = $('#apps-list'),
$emptyList = $('#apps-list-empty');
$appList.removeClass('hidden');
$appList.find('.section').removeClass('hidden');
$emptyList.addClass('hidden');
if (self._loading) {
return;
}
if (query === '') {
return;
}
query = query.toLowerCase();
$appList.find('.section').addClass('hidden');
// App Name
var apps = _.filter(OC.Settings.Apps.State.apps, function (app) {
return app.name.toLowerCase().indexOf(query) !== -1;
});
// App ID
apps = apps.concat(_.filter(OC.Settings.Apps.State.apps, function (app) {
return app.id.toLowerCase().indexOf(query) !== -1;
}));
// App Description
apps = apps.concat(_.filter(OC.Settings.Apps.State.apps, function (app) {
return app.description.toLowerCase().indexOf(query) !== -1;
}));
// Author Name
apps = apps.concat(_.filter(OC.Settings.Apps.State.apps, function (app) {
if (_.isUndefined(app.author)) {
return false;
}
return self._parseAppAuthor(app.author).toLowerCase().indexOf(query) !== -1;
}));
// App status
if (t('settings', 'Official').toLowerCase().indexOf(query) !== -1) {
apps = apps.concat(_.filter(OC.Settings.Apps.State.apps, function (app) {
return app.level === 200;
}));
}
if (t('settings', 'Approved').toLowerCase().indexOf(query) !== -1) {
apps = apps.concat(_.filter(OC.Settings.Apps.State.apps, function (app) {
return app.level === 100;
}));
}
if (t('settings', 'Experimental').toLowerCase().indexOf(query) !== -1) {
apps = apps.concat(_.filter(OC.Settings.Apps.State.apps, function (app) {
return app.level !== 100 && app.level !== 200;
}));
}
apps = _.uniq(apps, function(app){return app.id;});
if (apps.length === 0) {
$appList.addClass('hidden');
$emptyList.removeClass('hidden');
$emptyList.removeClass('hidden').find('h2').text(t('settings', 'No apps found for {query}', {
query: query
}));
} else {
_.each(apps, function (app) {
$('#app-' + app.id).removeClass('hidden');
});
$('#searchresults').hide();
}
},
_onPopState: function(params) {
params = _.extend({
category: 'enabled'
}, params);
OC.Settings.Apps.loadCategory(params.category);
},
/**
* Initializes the apps list
*/
initialize: function($el) {
OC.Plugins.register('OCA.Search', OC.Settings.Apps.Search);
OC.Settings.Apps.loadCategories();
OC.Util.History.addOnPopStateHandler(_.bind(this._onPopState, this));
$(document).on('click', '#apps-header button', function () {
var categoryId = $(this).data('category');
OC.Settings.Apps.loadCategory(categoryId);
OC.Util.History.pushState({
sectionid: 'apps',
category: categoryId
});
$('#searchbox').val('');
});
$(document).on('click', '.app-description-toggle-show', function () {
$(this).addClass('hidden');
$(this).siblings('.app-description-toggle-hide').removeClass('hidden');
$(this).siblings('.app-description-container').slideDown();
});
$(document).on('click', '.app-description-toggle-hide', function () {
$(this).addClass('hidden');
$(this).siblings('.app-description-toggle-show').removeClass('hidden');
$(this).siblings('.app-description-container').slideUp();
});
$(document).on('click', '#apps-list input.enable', function () {
var appId = $(this).data('appid');
var element = $(this);
var active = $(this).data('active');
OC.Settings.Apps.enableApp(appId, active, element);
});
$(document).on('click', '#apps-list input.uninstall', function () {
var appId = $(this).data('appid');
var element = $(this);
OC.Settings.Apps.uninstallApp(appId, element);
});
$(document).on('click', '#apps-list input.update', function () {
var appId = $(this).data('appid');
var element = $(this);
OC.Settings.Apps.updateApp(appId, element);
});
$(document).on('change', '#group_select', function() {
var element = $(this).parent().find('input.enable');
var groups = $(this).val();
if (groups && groups !== '') {
groups = groups.split('|');
} else {
groups = [];
}
var appId = element.data('appid');
if (appId) {
OC.Settings.Apps.enableApp(appId, false, element, groups);
OC.Settings.Apps.State.apps[appId].groups = groups;
}
});
$(document).on('change', ".groups-enable__checkbox", function() {
var $select = $(this).closest('.section').find('#group_select');
$select.val('');
if (this.checked) {
OC.Settings.Apps.setupGroupsSelect($select);
} else {
$select.select2('destroy');
}
$select.change();
});
}
};
OC.Settings.Apps.Search = {
attach: function (search) {
search.setFilter('settings', OC.Settings.Apps.filter);
}
};
$(document).ready(function () {
// HACK: FIXME: use plugin approach
if (!window.TESTING) {
OC.Settings.Apps.initialize($('#apps-list'));
}
});