Made SortBy option configurable

Author: vasil-sokolov

js/Settings.js

@@ -16,6 +16,7 @@ module.exports = {
 	Storages: [],
 	DefaultStorage: 'personal',
 	AllowAddressBooksManagement: false,
+	ContactsSortBy: {},
 
 	ImportExportFormats: [],
 	SaveVcfServerModuleName: '',
@@ -52,14 +53,17 @@ module.exports = {
 				this.Storages.push('group');
 			}
 			this.AllowAddressBooksManagement = Types.pBool(oAppDataSection.AllowAddressBooksManagement, this.AllowAddressBooksManagement);
-
+			
 			this.ImportExportFormats = Types.pArray(oAppDataSection.ImportExportFormats, this.ImportExportFormats);
 			this.SaveVcfServerModuleName = Types.pString(oAppDataSection.SaveVcfServerModuleName, this.SaveVcfServerModuleName);
-
+			
 			this.EContactsPrimaryEmail = Types.pObject(oAppDataSection.PrimaryEmail);
 			this.EContactsPrimaryPhone = Types.pObject(oAppDataSection.PrimaryPhone);
 			this.EContactsPrimaryAddress = Types.pObject(oAppDataSection.PrimaryAddress);
 			this.EContactSortField = Types.pObject(oAppDataSection.SortField);
+			this.ContactsSortBy = this.getSortConfig(Types.pObject(oAppDataSection.ContactsSortBy));
+
+			console.log('ContactsSortBy', this.ContactsSortBy);
 		}
 	},
 
@@ -71,5 +75,15 @@ module.exports = {
 	update: function (iContactsPerPage)
 	{
 		this.ContactsPerPage = iContactsPerPage;
+	},
+
+	getSortConfig: function (config)
+	{
+		return {
+			Allow: config.Allow ? true : false,
+			DisplayOptions: config.DisplayOptions || [],
+			DefaultSortBy: config.DefaultSortBy && config.Allow ? config.DefaultSortBy : 'Name',
+			DefaultSortOrder: config.DefaultSortOrder && config.Allow ? config.DefaultSortOrder : 'Desc'
+		};
 	}
 };

js/views/CContactsView.js

@@ -213,18 +213,27 @@ function CContactsView()
 		}
 	}, this);
 
-	this.sortBy = ko.observable(Enums.ContactSortField.Name); // Email: 2, Frequency: 3, Name: 1
-	this.sortOrder =  ko.observable(Enums.SortOrder.Asc); // Asc: 0, Desc: 1
+	this.bSortEnabled = Settings.ContactsSortBy && Settings.ContactsSortBy.Allow 
+		&& Settings.ContactsSortBy.DisplayOptions && Settings.ContactsSortBy.DisplayOptions.length > 0;
+	
+	// Had to set it here because in Setting.init not all Enums are defined
+	Settings.ContactsSortBy.DefaultSortBy = Enums.ContactSortField[Settings.ContactsSortBy.DefaultSortBy];
+	Settings.ContactsSortBy.DefaultSortOrder = Enums.SortOrder[Settings.ContactsSortBy.DefaultSortOrder];
+
+	this.sortBy = ko.observable(Settings.ContactsSortBy.DefaultSortBy);
+	this.sortOrder = ko.observable(Settings.ContactsSortBy.DefaultSortOrder);
 
 	this.aSortList = [];
-	_.each(Enums.ContactSortField, function (iValue, sName, oItem) {
-		this.aSortList.push({
-			sText: TextUtils.i18n('%MODULENAME%/SORT_OPTION_' + sName.toUpperCase()),
-			sSortBy: iValue,
-			// sortOrder: ko.observable(Enums.SortOrder.Asc),
-			// selected: ko.observable(sName === this.sSortBy)
-		});
-	}.bind(this));
+	if (this.bSortEnabled) {
+		_.each(Enums.ContactSortField, function (iValue, sName) {
+			if (Settings.ContactsSortBy.DisplayOptions.indexOf(sName) >= 0) {
+				this.aSortList.push({
+					sText: TextUtils.i18n('%MODULENAME%/SORT_OPTION_' + sName.toUpperCase()),
+					sSortBy: iValue
+				});
+			}
+		}.bind(this));
+	}
 
 	this.isSearchFocused = ko.observable(false);
 	this.searchInput = ko.observable('');
@@ -414,7 +423,7 @@ CContactsView.prototype.executeSort = function (sValue)
 	if (sCurrentSort === sValue) {
 		this.sortOrder(this.sortOrder() === Enums.SortOrder.Asc ? Enums.SortOrder.Desc : Enums.SortOrder.Asc); // Asc: 0, Desc: 1
 	} else {
-		this.sortOrder(Enums.SortOrder.Asc);
+		this.sortOrder(Enums.SortOrder[Settings.ContactsSortBy.DefaultSortOrder]);
 	}
 
 	this.requestContactList();
@@ -1095,7 +1104,6 @@ CContactsView.prototype.requestContactList = function ()
 	Ajax.send('GetContacts', {
 		'Offset': (this.currentPage() - 1) * Settings.ContactsPerPage,
 		'Limit': Settings.ContactsPerPage,
-		// 'SortField': Enums.ContactSortField.Name,
 		'SortField': this.sortBy(),
 		'SortOrder': this.sortOrder(),
 		'Search': this.search(),

templates/Toolbar/ContactsView.html

@@ -20,7 +20,7 @@
 			<span class="text" data-bind="i18n: {'key': '%MODULENAME%/ACTION_UNSHARE'}"></span>
 		</span>
 
-		<!-- ko template: {name: '%ModuleName%_Toolbar_SortButtonView'} --><!-- /ko -->
+		<!-- ko template: {name: '%ModuleName%_Toolbar_SortButtonView', if: bSortEnabled,} --><!-- /ko -->
 
 		<span class="item control" data-bind="visible: visibleImportExport() && isImportAllowed(), dropdown: {control: false}">
 			<span class="icon arrow"></span>