(feat) enabled custom builds, added sogo-demo as example and improved doc

Author: Ludovic Marcotte

Makefile

@@ -1,13 +1,13 @@
 PACKAGE = sogo-connector
 GIT_REV = $(shell git rev-parse --verify HEAD | cut -c1-10)
 
-#ifeq ($(shell uname),Darwin)
-#VERSION = $(shell grep em:version install.rdf | sed -E 's@(em:version=|"| )@@g')
-#else
-#VERSION = $(shell grep em:version install.rdf | sed -e 's@\(em:version=\|\"\|\ \)@@g')
-#endif
-VERSION=68.0.0
+ifeq ($(shell uname),Darwin)
+VERSION = $(shell grep em:version install.rdf | sed -E 's@(em:version=|"| )@@g')
+else
+VERSION = $(shell grep em:version install.rdf | sed -e 's@\(em:version=\|\"\|\ \)@@g')
+endif
 
+FIND_FILTER = ! -path './custom/*' -type f
 XPI_ARCHIVE = $(PACKAGE)-$(VERSION)-$(GIT_REV).xpi
 
 SHELL = /bin/bash
@@ -17,6 +17,16 @@ FILENAMES = $(shell cat MANIFEST)
 
 all: MANIFEST-pre MANIFEST rest
 
+custom-build:
+	@if test "x$$build" == "x"; then \
+	  echo "Building package with default settings."; \
+	else \
+	  echo "Building package with custom settings for '$$build'."; \
+	  if ! test -d custom/$$build; then \
+	    echo "Custom build '$$build' does not exist"; \
+	    exit 1; \
+	  fi; fi
+
 MANIFEST: MANIFEST-pre
 	@if ! cmp MANIFEST MANIFEST-pre >& /dev/null; then \
 	  mv -f MANIFEST-pre MANIFEST; \
@@ -26,25 +36,24 @@ MANIFEST: MANIFEST-pre
 	fi;
 
 MANIFEST-pre:
-#	@echo install.rdf > $@
 	@echo manifest.json > $@
 	@echo COPYING >> $@
 	@echo ChangeLog.old >> $@
-	@find . -type f -name "*.manifest" >> $@
-	@find . -type f -name "*.xul" >> $@
-	@find . -type f -name "*.xml" >> $@
-	@find . -type f -name "*.dtd" >> $@
-	@find . -type f -name "*.idl" >> $@
-	@find . -type f -name "*.js" >> $@
-	@find . -type f -name "*.jsm" >> $@
-	@find . -type f -name "*.css" >> $@
-	@find . -type f -name "*.png" >> $@
-	@find . -type f -name "*.gif" >> $@
-	@find . -type f -name "*.jpg" >> $@
-	@find . -type f -name "*.xpt" >> $@
-	@find . -type f -name "*.properties" >> $@
-	@find . -type f -name "*.rdf" >> $@
-	@find . -type f -name "RELEASE-NOTES" >> $@	
+	@find . $(FIND_FILTER) -name "*.manifest" >> $@
+	@find . $(FIND_FILTER) -name "*.xul" >> $@
+	@find . $(FIND_FILTER) -name "*.xml" >> $@
+	@find . $(FIND_FILTER) -name "*.dtd" >> $@
+	@find . $(FIND_FILTER) -name "*.idl" >> $@
+	@find . $(FIND_FILTER) -name "*.js" >> $@
+	@find . $(FIND_FILTER) -name "*.jsm" >> $@
+	@find . $(FIND_FILTER) -name "*.css" >> $@
+	@find . $(FIND_FILTER) -name "*.png" >> $@
+	@find . $(FIND_FILTER) -name "*.gif" >> $@
+	@find . $(FIND_FILTER) -name "*.jpg" >> $@
+	@find . $(FIND_FILTER) -name "*.xpt" >> $@
+	@find . $(FIND_FILTER) -name "*.properties" >> $@
+	@find . $(FIND_FILTER) -name "*.rdf" >> $@
+	@find . $(FIND_FILTER) -name "RELEASE-NOTES" >> $@	
 
 rest: MANIFEST
 	@+make $(XPI_ARCHIVE)
@@ -53,6 +62,10 @@ $(XPI_ARCHIVE): $(FILENAMES)
 	@echo Generating $(XPI_ARCHIVE)...
 	@rm -f $(XPI_ARCHIVE)
 	@$(ZIP) -9r $(XPI_ARCHIVE) $(FILENAMES) > /dev/null
+	@if test "x$$build" != "x"; then \
+	  cd custom/$$build; \
+	  $(ZIP) -9r ../../$(XPI_ARCHIVE) * > /dev/null; \
+	fi
 
 clean:
 	rm -f MANIFEST-pre $(XPI_ARCHIVE)

README

@@ -1,8 +1,25 @@
 =====================================================	
 	To package the extension 
 =====================================================
-edit <em:version> in install.rdf
-run make
+
+First create a directory structure in custom/ that corresponds to your site
+name. Use "sogo-demo" as an example. You can do so by doing:
+
+cp -a custom/sogo-demo custom/mysite
+
+Then customize the following files:
+
+custom/mysite/defaults/preferences/site.js
+custom/mysite/chrome/content/sogo-connector/global/extensions.rdf
+
+If you want to force-push preferences upon each startup, modify:
+
+custom/mysite//chrome/content/sogo-connector/general/custom-preferences.js
+
+To build the extension, do:
+
+% make distclean
+% make build=mysite
 
 ========================================================
 	Logging
@@ -11,8 +28,7 @@ run make
 For development enable debug messages
 -------------------------------------
 
-Taken from:
-http://brainflush.wordpress.com/2008/01/17/mozilla-thunderbird-extension-development-environment-setup/
+Taken from: http://brainflush.wordpress.com/2008/01/17/mozilla-thunderbird-extension-development-environment-setup/
 
 javascript.options.showInConsole = true.
   Logs errors in chrome files to the Error Console.
@@ -26,13 +42,18 @@ browser.dom.window.dump.enabled = true.
 javascript.options.strict = true.
   Enables strict JavaScript warnings in the Error Console. Note that since many people have this setting turned off when developing, you will see lots of warnings for problems with their code in addition to warnings for your own extension. You can filter those with Console2.
 
+You can do so automatically by setting these preferences in site.js:
+
+pref("javascript.options.showInConsole", true);
+pref("nglayout.debug.disable_xul_cache", true);
+pref("browser.dom.window.dump.enabled", true);
+pref("javascript.options.strict", true);
 
 
 Making the standard output console visible
 -------------------------------------------
 
-Taken from:
-https://developer.mozilla.org/en-US/docs/DOM/window.dump?redirectlocale=en-US&redirectslug=DOM%3Awindow.dump
+Taken from: https://developer.mozilla.org/en-US/docs/DOM/window.dump?redirectlocale=en-US&redirectslug=DOM%3Awindow.dump
 
 On Windows, you will need a console to actually see anything. If you don't have one already, closing the application and re-opening it with the command line parameter -console should create the console. On other operating systems, it's enough to launch the application from a terminal.
 
@@ -67,3 +88,30 @@ Modifications to Lightning (such as methods overwrite) are done within
 // INVERSE - BEGIN
 
 // INVERSE - END
+
+
+========================================================
+     Migrating to Thunderbird v68
+========================================================
+
+First of all, SOGo Integrator is no longer needed.
+
+All SOGo Integrator preferences have been renamed to
+"sogo-connector". For example:
+
+sogo-integrator.disable-calendaring
+
+was renamed to:
+
+sogo-connector.disable-calendaring
+
+Here is the list of renamed preference keys:
+
+sogo-integrator.autocomplete.server.urlid
+sogo-integrator.disable-calendaring
+sogo-integrator.disable-send-invitations-checkbox
+
+
+All SOGo Connector preferences:
+
+sogo-connector.autoComplete.commentAttribute

custom/sogo-demo/chrome/content/sogo-connector/general/custom-preferences.js

@@ -0,0 +1,4 @@
+force_int_pref("calendar.autorefresh.timeout", 30);
+force_int_pref("calendar.invitations.autorefresh.timeout", 30);
+force_bool_pref("sogo-connector.disable-send-invitations-checkbox", false);
+force_char_pref("sogo-connector.autoComplete.commentAttribute, "JobTitle");

custom/sogo-demo/chrome/content/sogo-connector/global/extensions.rdf

@@ -0,0 +1,15 @@
+<?xml version="1.0"?>
+<!DOCTYPE RDF>
+<RDF xmlns="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
+  xmlns:isi="http://inverse.ca/sogo-connector/"
+  xmlns:em="http://www.mozilla.org/2004/em-rdf#"
+  xmlns:NC="http://home.netscape.com/NC-rdf#">
+  <Seq about="http://inverse.ca/sogo-connector/extensions"
+    isi:updateURL="http://sogo-demo.inverse.ca/plugins/updates.php?plugin=%ITEM_ID%&amp;version=%ITEM_VERSION%&amp;platform=%PLATFORM%">
+    <li>
+      <Description
+        em:id="[email protected]"
+        em:name="SOGo Connector"/>
+    </li>
+  </Seq>
+</RDF>

custom/sogo-demo/defaults/preferences/site.js

@@ -0,0 +1,13 @@
+pref("app.update.auto", false);
+pref("app.update.enabled", false);
+pref("autoupdate.enabled", false);
+pref("extensions.update.auto", false);
+pref("extensions.update.enabled", false);
+pref("mail.imap.mime_parts_on_demand_threshold", 300000);
+pref("mail.inline_attachments", true);
+pref("mail.mdn.report.not_in_to_cc", 0);
+pref("mail.strictly_mime.parm_folding", 0);
+pref("calendar.alarms.showmissed", false);
+pref("calendar.caldav.sched.enabled", true);
+pref("calendar.timezone.local", "/mozilla.org/20070129_1/America/Montreal");
+pref("sogo-connector.autocomplete.server.urlid", "public");