1 #---------------------------------------------------------
2 # Makefile.am for xul/staff_client
3 ## Process this file with automake to generate Makefile.in
4 #---------------------------------------------------------
6 export STAFF_CLIENT_BUILD_ID = $$(/bin/cat build/BUILD_ID)
7 export STAFF_CLIENT_VERSION = $$(/bin/cat build/VERSION)
8 export STAFF_CLIENT_STAMP_ID = $$(/bin/cat build/STAMP_ID)
10 # from http://closure-compiler.googlecode.com/files/compiler-latest.zip FIXME: Autotools this?
11 export CLOSURE_COMPILER_JAR = ~/closure-compiler/compiler.jar
13 # XULRunner is our base.
14 XULRUNNER_VERSION=14.0.1
15 XULRUNNER_WINFILE=xulrunner-$(XULRUNNER_VERSION).en-US.win32.zip
16 XULRUNNER_LINUXFILE=xulrunner-$(XULRUNNER_VERSION).en-US.linux-i686.tar.bz2
17 XULRUNNER_URL=ftp://ftp.mozilla.org/pub/mozilla.org/xulrunner/releases/$(XULRUNNER_VERSION)/runtimes/
18 XULRUNNER_MAJOR_VERSION=$$(echo ${XULRUNNER_VERSION} | cut -d. -f1)
20 # Extensions we include when not an extension ourselves
21 # Grab the latest. If that becomes a problem we can swap them out for specific versions.
22 DOMINSPECTOR_URL=https://addons.mozilla.org/firefox/downloads/latest/6622/addon-6622-latest.xpi
23 DOMINSPECTOR_ID=inspector@mozilla.org
24 VENKMAN_URL=https://addons.mozilla.org/firefox/downloads/latest/216/addon-216-latest.xpi
25 VENKMAN_ID={f13b157f-b174-47e7-a34d-4815ddfdfeb8}
27 OPENSRF_JSLIBS = "$(OPENSRF_LIBS)/javascript"
28 CHROME_LOCALES = $$(ls -1 chrome/locale)
29 SKIN_CSS = $$(ls -1 server/skin/*css | sed -e "s/.css/_custom.css/")
30 UPDATESDIR=@localstatedir@/updates
32 GIT_BRANCH=$$(echo $$(git rev-parse --abbrev-ref HEAD || echo master) | sed 's|.*/||')
33 GIT_TAG=$$(git rev-parse --short HEAD) # For auto-tagging builds
36 export NSIS_WICON=$$(if [ -f client/evergreen.ico ]; then echo '-DWICON'; fi)
37 export NSIS_AUTOUPDATE=$$([ -f client/defaults/preferences/autoupdate.js ] && echo '-DAUTOUPDATE')
38 export NSIS_DEV=$$([ -f client/defaults/preferences/developers.js ] && echo '-DDEVELOPER')
39 export NSIS_PERMACHINE=$$([ -f client/defaults/preferences/aa_per_machine.js ] && echo '-DPERMACHINE')
40 export NSIS_EXTRAS=$$([ -f extras.nsi ] && echo '-DEXTRAS')
41 # Url taken from http://nsis.sourceforge.net/AccessControl_plug-in
42 NSIS_ACCESSCONTROL=http://nsis.sourceforge.net/mediawiki/images/4/4a/AccessControl.zip
44 #------------------------------
45 # Build ILS XUL CLIENT/SERVER
46 #------------------------------
49 OILSSERVER_INST = server-xul
52 install-exec-local: $(OILSSERVER_INST)
55 # For when you want to add devbuild/permachine/autoupdate to an existing stamp id
56 rebuild: export STAFF_CLIENT_STAMP_ID=`cat PREV_STAMP_ID`
57 rebuild: export STAFF_CLIENT_VERSION=`cat PREV_VERSION`
61 @echo ' * Rigging for release branding'
62 @cp xulrunner-stub.release.exe xulrunner-stub.exe
64 @cp evergreen-icon.ico branding/evergreen.ico
65 @sed -i -e 's/^\s*;\?\s*!define UI_IMAGESET "release"/!define UI_IMAGESET "release"/' -e 's/^\s*;\?\s*!define UI_IMAGESET "beta"/;!define UI_IMAGESET "beta"/' windowssetup.nsi
68 @echo ' * Rigging for beta branding'
69 @cp xulrunner-stub.beta.exe xulrunner-stub.exe
71 @cp evergreen-icon-beta.ico branding/evergreen.ico
72 @sed -i -e 's/^\s*;\?\s*!define UI_IMAGESET "release"/;!define UI_IMAGESET "release"/' -e 's/^\s*;\?\s*!define UI_IMAGESET "beta"/!define UI_IMAGESET "beta"/' windowssetup.nsi
75 @echo ' * Copying in developer preferences'
76 @cp external/developers.js build/defaults/preferences/
79 @echo ' * Copying in default to machine level registration file'
80 @cp external/aa_per_machine.js build/defaults/preferences/
82 build: build_dir chrome2remote localize_manifest generated custom_skins open-ils stamp
83 @echo To test the staff client:
85 @echo " xulrunner application.ini"
88 @echo ' * Creating and populating build/ '
93 @cp -fR defaults build/
94 @cp -fR components build/
95 @cp application.ini build/
96 @cp chrome.manifest build/
97 @if [ -f "install.mccoy.rdf" ]; then cp install.mccoy.rdf build/install.rdf; else cp install.rdf build/; fi
98 @cp -fR build/chrome/content/util/ build/server/
99 @cp -fR build/chrome/content/auth/ build/server/
100 @cp build/chrome/content/main/constants.js build/server/main/constants.js
101 @cp build/chrome/content/main/bindings.xml build/server/main/bindings.xml
102 @cp build/chrome/content/OpenILS/data.js build/server/OpenILS/data.js
103 @cp build/chrome/content/OpenILS/global_util.js build/server/OpenILS/global_util.js
104 @if [ -d branding ]; then cp -fR branding/* build/; fi
105 @external/prune_dirs.sh build/
107 # Convert chrome to remote for server localization
109 @for loc in $(CHROME_LOCALES); do \
110 cp -fr chrome/locale/$$loc build/server/locale/. ; \
113 # Update the manifest for our installed locales
115 @for loc in $(CHROME_LOCALES) ; do \
116 if [ "$$loc" != "en-US" ]; then ( echo "locale open_ils_staff_client $$loc locale/$$loc/" >> build/chrome/chrome.manifest ) ; fi; \
120 # https://developer.mozilla.org/en/xul_application_packaging
121 # The Documentation states:
122 # BUILD ID should be a unique build identifier, usually date based, and should be different for each released version
123 # VERSION should be in a format as described here:
124 # https://developer.mozilla.org/en/Toolkit_version_format
126 # The default "automatic" BUILD ID is acceptable.
128 # The version from the README usually conforms to that documentation, unless it is master.
129 # If we are in master, we probably have git kicking around, ask it for the revision and build an appropriate version string.
131 # Neither really applies to the STAMP, though.
132 # The method below gives the same format STAMPS as previous instructions provided. If README has version 1.2.3.4 then STAMP_ID will become rel_1_2_3_4.
133 # Master VERSION will end up with 0branch.release, master STAMP ID will be 0branch_release.
135 @/bin/date +"%Y%m%d.%H%M%S" > build/BUILD_ID
136 @if [ -n "${STAFF_CLIENT_BUILD_ID}" ]; then ( echo "Stamping with Build ID: ${STAFF_CLIENT_BUILD_ID}" ; echo ${STAFF_CLIENT_BUILD_ID} > build/BUILD_ID ) ; fi
137 @if [ -z "${STAFF_CLIENT_BUILD_ID}" ]; then ( echo "No Build ID for versioning" ; echo "none" > build/BUILD_ID ) ; fi
138 @sed -n -e '1 s/^.* \([^ ]*\)$$/\1/p' @top_srcdir@/README > build/VERSION
139 @if [ "${STAFF_CLIENT_VERSION}" == "master" ]; then echo "0${GIT_BRANCH}.${GIT_TAG}" > build/VERSION; fi
140 @if [ -n "${STAFF_CLIENT_VERSION}" ]; then ( echo "Stamping with Version: ${STAFF_CLIENT_VERSION}" ; echo ${STAFF_CLIENT_VERSION} > build/VERSION ) ; fi
141 @if [ -z "${STAFF_CLIENT_VERSION}" ]; then ( echo "No Version" ; echo "none" > build/VERSION ) ; fi
142 @sed -e 's/\./_/g' -e 's/^\([0-9_]*\)$$/rel_&/' build/VERSION > build/STAMP_ID
143 @if [ -n "${STAFF_CLIENT_STAMP_ID}" ]; then ( echo "Stamping with Stamp ID: ${STAFF_CLIENT_STAMP_ID}" ; echo ${STAFF_CLIENT_STAMP_ID} > build/STAMP_ID ) ; fi
144 @if [ -z "${STAFF_CLIENT_STAMP_ID}" ]; then ( echo "No Stamp ID for versioning" ; echo "none" > build/STAMP_ID ) ; fi
145 @if [ -n "${STAFF_CLIENT_VERSION}" ]; then sed -i -e s/^Version=.\*/Version=${STAFF_CLIENT_VERSION}/ build/application.ini ; fi
146 @if [ -n "${STAFF_CLIENT_VERSION}" ]; then sed -i -e "s|<em:version>.*</em:version>|<em:version>${STAFF_CLIENT_VERSION}</em:version>|" build/install.rdf ; fi
147 @if [ -n "${STAFF_CLIENT_VERSION}" ]; then find build/ -name 'constants.js' -exec sed -i -e "s/\(CLIENT_VERSION *= '\)'/\1${STAFF_CLIENT_VERSION}'/" {} \; ; fi
148 @if [ -n "${STAFF_CLIENT_BUILD_ID}" ]; then sed -i -e s/^BuildID=.\*/BuildID=${STAFF_CLIENT_BUILD_ID}/ build/application.ini ; fi
149 @if [ -n "${STAFF_CLIENT_STAMP_ID}" ]; then find build/ -name '*.css' -exec sed -i -e s/xul\\\/server/xul\\\/${STAFF_CLIENT_STAMP_ID}\\\/server/g {} \; ; fi
150 @if [ -n "${STAFF_CLIENT_STAMP_ID}" ]; then find build/ -name '*.xul' -exec sed -i -e s/xul\\\/server/xul\\\/${STAFF_CLIENT_STAMP_ID}\\\/server/g {} \; ; fi
151 @if [ -n "${STAFF_CLIENT_STAMP_ID}" ]; then find build/ -name '*.html' -exec sed -i -e s/xul\\\/server/xul\\\/${STAFF_CLIENT_STAMP_ID}\\\/server/g {} \; ; fi
152 @if [ -n "${STAFF_CLIENT_STAMP_ID}" ]; then find build/ -name '*.xhtml' -exec sed -i -e s/xul\\\/server/xul\\\/${STAFF_CLIENT_STAMP_ID}\\\/server/g {} \; ; fi
153 @if [ -n "${STAFF_CLIENT_STAMP_ID}" ]; then find build/ -name '*.js' -exec sed -i -e s/xul\\\/server/xul\\\/${STAFF_CLIENT_STAMP_ID}\\\/server/g {} \; ; fi
154 @if [ -n "${STAFF_CLIENT_STAMP_ID}" ]; then find build/ -name '*.xml' -exec sed -i -e s/xul\\\/server/xul\\\/${STAFF_CLIENT_STAMP_ID}\\\/server/g {} \; ; fi
155 @if [ -n "${STAFF_CLIENT_STAMP_ID}" ]; then find build/ -name 'constants.js' -exec sed -i -e "s/\(CLIENT_STAMP *= '\)'/\1${STAFF_CLIENT_STAMP_ID}'/" {} \; ; fi
156 @if [ -n "${STAFF_CLIENT_NAME}" ]; then sed -i -e s/^Name=.\*/Name=${STAFF_CLIENT_NAME}/ build/application.ini ; fi
157 @if [ -z "${AUTOUPDATE_HOST}" ]; then rm -f build/defaults/preferences/autoupdate.js; fi
158 @if [ -z "${AUTOUPDATE_HOST}" ]; then sed -i -e /updateURL/d build/install.rdf; fi
159 @if [ -n "${AUTOUPDATE_HOST}" ]; then echo "Applying automatic update host ${AUTOUPDATE_HOST}"; fi
160 @if [ -n "${AUTOUPDATE_HOST}" ]; then sed -i -e "s|::HOSTNAME::|${AUTOUPDATE_HOST}|" -e "s|https\?://\(https\?://\)|\1|" build/defaults/preferences/autoupdate.js; fi
161 @if [ -n "${AUTOUPDATE_HOST}" ]; then sed -i -e "s|::HOSTNAME::|${AUTOUPDATE_HOST}|" -e "s|https\?://\(https\?://\)|\1|" build/install.rdf; fi
162 @cp build/STAMP_ID PREV_STAMP_ID
163 @cp build/VERSION PREV_VERSION
166 @perl -e 'print "Ringing bell..." . chr(7) . "\n";'
169 @rm -f build/build.tar
170 @tar -c --exclude=server -f build.tar build/
172 @md5sum build/build.tar > build/build.tar.md5
175 @echo ' * Grabbing lang.dtd from the OPAC code '
176 @cp @top_srcdir@/Open-ILS/web/opac/locale/en-US/lang.dtd build/chrome/locale/en-US/
179 @echo ' * Grabbing more OPAC code and legacy code and custom code'
180 @cp @top_srcdir@/Open-ILS/web/opac/common/js/*.js build/chrome/content/OpenILS/util/
181 @cp $(OPENSRF_JSLIBS)/*.js build/chrome/content/OpenILS/util/
182 @external/prune_dirs.sh build/
185 @for skin in $(SKIN_CSS); do \
186 if [ ! -f "$$skin" ]; then ( touch build/"$$skin" ); fi \
190 @if [ -z "$(WEBDIR)" ]; then echo "!!!--------!!!"; echo "WEBDIR is not set. Must use top level Makefile or set WEBDIR to use this target."; echo "!!!--------!!!"; exit 1; fi
192 server-xul: needwebdir build
194 mkdir -p $(DESTDIR)$(WEBDIR)
195 mkdir -p $(DESTDIR)$(WEBDIR)/xul/
196 @echo "STAMP_ID = $(STAFF_CLIENT_STAMP_ID)"
197 @echo "Copying xul into $(DESTDIR)$(WEBDIR)/xul/$(STAFF_CLIENT_STAMP_ID)"
198 mkdir -p "$(DESTDIR)$(WEBDIR)/xul/$(STAFF_CLIENT_STAMP_ID)"
199 cp -R @top_srcdir@/Open-ILS/xul/staff_client/build/server "$(DESTDIR)${WEBDIR}/xul/${STAFF_CLIENT_STAMP_ID}/"
201 compress-javascript: build
202 @echo "Size of build/ before compression = " `du -sh build/`
203 @echo " * Running Google's Closure Compiler against javascript. Errors in build/compression.err"
204 @external/closure_compiler.sh $(CLOSURE_COMPILER_JAR) 2>> build/compression.err
205 @echo `find build/ -name '*.js~' -size 0 -print | wc -l` compression failures
206 @find build/ -name '*.js~' -size 0 -exec rm {} \; # remove the output files for those that did not compile
207 @echo `find build/ -name '*.js~' -print | wc -l` compression successes
208 @find build/ -name '*.js~' -exec perl -e '$$a = "{}"; chop $$a; `mv $$a~ $$a`;' \;
209 @echo "Size of build/ (minus compression.err) after compression = " `du -sh --exclude compression.err build/`
211 # Easy way to make all three kinds of clients
218 # By doing this we don't change the original build in the build folder
219 # Great for adding/changing things without a full rebuild
222 @if [ ! -f build/BUILD_ID ]; then echo 'ERROR! Current build not stamped!'; exit 1; fi
223 @echo 'Prepping Client Set'
226 @cp -fR build/* client/
227 @rm -rf client/server/
228 @rm -f client/build.tar*
230 # When building as a standalone client install.rdf is a bad thing
231 # as we haven't "sanitized" the client for extension use
233 client_app: client_dir
234 @echo 'Cleaning Extension Information'
235 @rm -f client/install.rdf
236 @echo 'Installing Extensions'
237 @mkdir -p client/extensions
238 # Note: XULRunner before 4 requires extracted extensions
239 # XULRunner after 4 keeps them in XPI form...unless their manifest says to unpack
240 # This block is thus structured to make it easy to add the latter kind later.
241 @if [ ${XULRUNNER_MAJOR_VERSION} -lt 4 ]; then \
242 if [ -f extensions/${DOMINSPECTOR_ID}.xpi ]; then \
243 mkdir -p client/extensions/${DOMINSPECTOR_ID}/; \
244 unzip extensions/${DOMINSPECTOR_ID}.xpi -d client/extensions/${DOMINSPECTOR_ID}/; \
246 if [ -f extensions/${VENKMAN_ID}.xpi ]; then \
247 mkdir -p client/extensions/${VENKMAN_ID}/; \
248 unzip extensions/${VENKMAN_ID}.xpi -d client/extensions/${VENKMAN_ID}/; \
251 if [ -f extensions/${DOMINSPECTOR_ID}.xpi ]; then \
252 cp extensions/${DOMINSPECTOR_ID}.xpi client/extensions/; \
254 if [ -f extensions/${VENKMAN_ID}.xpi ]; then \
255 cp extensions/${VENKMAN_ID}.xpi client/extensions/; \
259 # If automatic updates are enabled, or the standalone_xul_app.js is present,
260 # the extension can break Firefox.
261 # Also, per machine registration + extension mode is probably a bad idea.
262 # Remove those, and we need an updated chrome.manifest
264 client_ext: client_dir
265 @echo 'Cleaning App Information'
266 @rm -f client/application.ini
267 @rm -f client/defaults/preferences/autoupdate.js
268 @rm -f client/defaults/preferences/autochannel.js
269 @rm -f client/defaults/preferences/standalone_xul_app.js
270 @rm -f client/defaults/preferences/aa_per_machine.js
271 @echo 'Prepping chrome.manifest'
272 @perl -ne 'if(/open_ils_staff_client/) { s/ (?!chrome:\/\/open_ils_staff_client)([^ ]*)$$/ chrome\/\1/; print; }' client/chrome/chrome.manifest > client/chrome.manifest
273 @grep -v manifest build/chrome.manifest >> client/chrome.manifest
275 # Would merge client_ext into this one, but this way an installer that doesn't
276 # use an xpi can be made for extension later, if desired
278 extension: client_ext
279 @echo ' * Packaging as an XPI'
280 @(cd client/ && zip -q -r ../evergreen.xpi * -x defaults/preferences/standalone_xul_app.js)
281 @md5sum evergreen.xpi > evergreen.xpi.md5
283 # Fetch extensions to load into the client
284 # This could be done in a "if they aren't there" fashion, but these are manually triggered anyway
285 # That, and this way you can update the extensions by running this target again
286 fetch-extensions: fetch-dom-inspector fetch-venkman
289 @echo 'Fetching DOM Inspector'
290 @mkdir -p extensions/
291 @wget -Oextensions/${DOMINSPECTOR_ID}.xpi ${DOMINSPECTOR_URL}
294 @echo 'Fetching Venkman'
295 @mkdir -p extensions/
296 @wget -Oextensions/${VENKMAN_ID}.xpi ${VENKMAN_URL}
298 # Generic client, as an xpi, theoretically suitable for --install-app usage
300 generic-client: client_app
301 @echo 'Packing Generic Client via zip (as xpi file)'
302 @rm -f evergreen_staff_client.xpi
303 @cd client && zip -q -r ../evergreen_staff_client.xpi *
306 # These two targets complete the layout defined on
307 # https://developer.mozilla.org/en/XULRunner/Deploying_XULRunner_1.8
308 # for their respective platforms in regards to XULRunner deployment
311 @echo 'Checking for makensis'
312 @type -P makensis > /dev/null || ( echo 'MAKENSIS NOT FOUND: Cannot continue. Do you need to install the NSIS package?' && exit 1 )
315 @echo 'Checking for unzip'
316 @type -P unzip > /dev/null || ( echo 'UNZIP NOT FOUND: Cannot continue.' && exit 1 )
319 @echo 'Checking for branding'
320 @[ -f xulrunner-stub.exe ] || echo 'xulrunner-stub.exe not found'
321 @[ -f build/evergreen.ico ] || echo 'build/evergreen.ico not found'
322 @if [ ! -f xulrunner-stub.exe -o ! -f build/evergreen.ico ]; then echo 'Branding incomplete. Did you forget to run "make rigbeta" or "make rigrelease"?'; echo 'You will need to "make rebuild" afterwards.'; exit 1; fi
324 # Note that I decided to use win/lin channels for ease of coding platform specific updates
326 win-xulrunner: unzip_check branding_check client_app
327 @echo 'Preparing Windows xulrunner'
328 @if [ ! -f ${XULRUNNER_WINFILE} ]; then wget ${XULRUNNER_URL}${XULRUNNER_WINFILE}; fi
329 @unzip -q ${XULRUNNER_WINFILE} -dclient
330 @if [ -f client/defaults/preferences/autoupdate.js ]; then echo 'pref("app.update.channel","win");' >> client/defaults/preferences/autochannel.js; fi;
331 @if [ -d branding_win ]; then cp -fR branding_win/* client/; fi
332 @echo 'Preparing stub'
333 @if [ -f xulrunner-stub.exe ]; then cp xulrunner-stub.exe client/evergreen.exe; rm client/xulrunner/xulrunner-stub.exe; else mv client/xulrunner/xulrunner-stub.exe client/evergreen.exe; fi
334 @if [ ${XULRUNNER_MAJOR_VERSION} -ge 4 -a -f client/xulrunner/mozcrt19.dll ]; then cp client/xulrunner/mozcrt19.dll client/; fi # XULRunner 4+ need this, if the file exists
335 @if [ ${XULRUNNER_MAJOR_VERSION} -ge 9 -a -f client/xulrunner/mozutils.dll ]; then cp client/xulrunner/mozutils.dll client/; fi # XULRunner 9+ need this, if the file exists
337 linux-xulrunner: client_app
338 @echo 'Preparing Linux xulrunner'
339 @if [ ! -f ${XULRUNNER_LINUXFILE} ]; then wget ${XULRUNNER_URL}${XULRUNNER_LINUXFILE}; fi
340 @cd client; tar xjf ../${XULRUNNER_LINUXFILE}; cd ..
341 @if [ -f client/defaults/preferences/autoupdate.js ]; then echo 'pref("app.update.channel","lin");' >> client/defaults/preferences/autochannel.js; fi;
342 @if [ -d branding_lin ]; then cp -fR branding_lin/* client/; fi
343 @echo 'Preparing stub'
344 @mv client/xulrunner/xulrunner-stub client/evergreen
346 # Build a windows installer.
348 win-client: nsis_check win-xulrunner
349 @if [ "${NSIS_AUTOUPDATE}${NSIS_PERMACHINE}" -a ! -d AccessControl ]; then echo 'Fetching AccessControl Plugin'; wget ${NSIS_ACCESSCONTROL} -O AccessControl.zip; unzip AccessControl.zip $$(unzip -t AccessControl.zip | grep 'AccessControl/Contrib/' > /dev/null || echo "-dAccessControl"); fi
350 @echo 'Building installer'
351 @makensis -V2 -DPRODUCT_VERSION="${STAFF_CLIENT_VERSION}" ${NSIS_WICON} ${NSIS_AUTOUPDATE} ${NSIS_DEV} ${NSIS_PERMACHINE} ${NSIS_EXTRAS} ${NSIS_EXTRAOPTS} windowssetup.nsi
354 # For linux, just build a tar.bz2 archive
356 linux-client: linux-xulrunner
357 @echo 'Packing as evergreen_staff_client.tar.bz2'
358 @rm -f evergreen_staff_client.tar.bz2
359 @cd client; tar cjf ../evergreen_staff_client.tar.bz2 *; cd ..
362 # For running the updates script with the correct updates directory, optionally building clients as well
364 updates updates-client win-updates win-updates-client linux-updates linux-updates-client generic-updates generic-updates-client extension-updates:
365 @if [ ! -f build/BUILD_ID ]; then echo 'ERROR! Current build not stamped!'; exit 1; fi
366 @if [ ! -x external/make_updates.sh ]; then chmod u+x external/make_updates.sh; fi
367 @if [ ! -x external/make_updates.sh ]; then echo 'ERROR! external/make_updates.sh is not executable!'; exit 1; fi
368 @external/make_updates.sh ${UPDATESDIR} $@