Merge branch 'patch-9' of https://github.com/gjones2/Freeside (#13854 as this bug...
[freeside.git] / Makefile
1 #!/usr/bin/make
2
3 #solaris and perhaps other very weirdass /bin/sh
4 #SHELL="/bin/ksh"
5
6 DB_TYPE = Pg
7 #DB_TYPE = mysql
8
9 DB_USER = freeside
10 DB_PASSWORD=
11
12 DATASOURCE = DBI:${DB_TYPE}:dbname=freeside
13
14 #changable now (some things which should go to the others still go to CONF)
15 FREESIDE_CONF = /usr/local/etc/freeside
16 FREESIDE_LOG = /usr/local/etc/freeside
17 FREESIDE_LOCK = /usr/local/etc/freeside
18 FREESIDE_CACHE = /usr/local/etc/freeside
19 FREESIDE_EXPORT = /usr/local/etc/freeside
20
21 MASON_HANDLER = ${FREESIDE_CONF}/handler.pl
22 MASONDATA = ${FREESIDE_CACHE}/masondata
23
24 #where to put the default configuraiton used by freeside-setup to initialize
25 #a new database (not used after that).  primarily of interest to distro
26 #package maintainers
27 DIST_CONF = ${FREESIDE_CONF}/default_conf
28
29 #deb
30 FREESIDE_DOCUMENT_ROOT = /var/www/freeside
31 #redhat, fedora, mandrake
32 #FREESIDE_DOCUMENT_ROOT = /var/www/html/freeside
33 #freebsd
34 #FREESIDE_DOCUMENT_ROOT = /usr/local/www/data/freeside
35 #openbsd
36 #FREESIDE_DOCUMENT_ROOT = /var/www/htdocs/freeside
37 #suse
38 #FREESIDE_DOCUMENT_ROOT = /srv/www/htdocs/freeside
39 #apache
40 #FREESIDE_DOCUMENT_ROOT = /usr/local/apache/htdocs/freeside
41
42 #deb, redhat, fedora, mandrake, suse, others?
43 INIT_FILE = /etc/init.d/freeside
44 #freebsd
45 #INIT_FILE = /usr/local/etc/rc.d/011.freeside.sh
46
47 #deb
48 INIT_INSTALL = PATH=$PATH:/sbin /usr/sbin/update-rc.d freeside defaults 23 01
49 #redhat, fedora
50 #INIT_INSTALL = /sbin/chkconfig freeside on
51 #not necessary (freebsd)
52 #INIT_INSTALL = /usr/bin/true
53
54 #deb, suse
55 #HTTPD_RESTART = /etc/init.d/apache restart
56 #deb w/apache2
57 HTTPD_RESTART = /etc/init.d/apache2 restart
58 #redhat, fedora, mandrake
59 #HTTPD_RESTART = /etc/init.d/httpd restart
60 #freebsd
61 #HTTPD_RESTART = /usr/local/etc/rc.d/apache.sh stop || true; sleep 10; /usr/local/etc/rc.d/apache.sh start
62 #openbsd
63 #HTTPD_RESTART = kill -TERM `cat /var/www/logs/httpd.pid`; sleep 10; /usr/sbin/httpd -u -DSSL
64 #apache
65 #HTTPD_RESTART = /usr/local/apache/bin/apachectl stop; sleep 10; /usr/local/apache/bin/apachectl startssl
66
67 #(an include directory, not a file, "Include /etc/apache/conf.d" in httpd.conf)
68 #deb (3.1+), apache2
69 APACHE_CONF = /etc/apache2/conf.d
70 INSSERV_OVERRIDE = /etc/insserv/overrides
71
72 FREESIDE_RESTART = ${INIT_FILE} restart
73
74 #deb, redhat, fedora, mandrake, suse, others?
75 INSTALLGROUP = root
76 #freebsd, openbsd
77 #INSTALLGROUP = wheel
78
79 #edit the stuff below to have the daemons start
80
81 QUEUED_USER=fs_queue
82
83 SELFSERVICE_USER = fs_selfservice
84 #never run on the same machine in production!!!
85 SELFSERVICE_MACHINES = 
86 # SELFSERVICE_MACHINES = www.example.com
87 # SELFSERVICE_MACHINES = web1.example.com web2.example.com
88
89 #user with sudo access on SELFSERVICE_MACHINES for automated self-service
90 #installation.
91 SELFSERVICE_INSTALL_USER = ivan
92 SELFSERVICE_INSTALL_USERADD = /usr/sbin/useradd
93 #SELFSERVICE_INSTALL_USERADD = "/usr/sbin/pw useradd"
94
95 #RT_ENABLED = 0
96 RT_ENABLED = 1
97 RT_DOMAIN = example.com
98 RT_TIMEZONE = US/Pacific
99 #RT_TIMEZONE = US/Eastern
100 FREESIDE_URL = "http://localhost/freeside/"
101
102 #for now, same db as specified in DATASOURCE... eventually, otherwise?
103 RT_DB_DATABASE = freeside
104
105 TORRUS_ENABLED = 0
106
107 # for auto-version updates, so we can "make release" more things automatically
108 RPM_SPECFILE = rpm/freeside.spec
109
110 #---
111
112 #rt/config.layout.in
113 RT_PATH = /opt/rt3
114
115 #only used for dev kludge now, not a big deal
116 FREESIDE_PATH = `pwd`
117 PERL_INC_DEV_KLUDGE = /usr/local/share/perl/5.14.2/
118
119 VERSION := `grep '^$$VERSION' FS/FS.pm | cut -d\' -f2`
120 TAG := freeside_`grep '^$$VERSION' FS/FS.pm | cut -d\' -f2 | perl -pe 's/\./_/g'`
121
122 #DEBVERSION = `echo ${VERSION} | perl -pe 's/(\d)([a-z])/\1~\2/'`-1
123
124 TEXMFHOME := "\$$TEXMFHOME"
125
126 ver:
127         @echo "${VERSION}"
128
129 tag:
130         @echo "${TAG}"
131
132 help:
133         @echo "supported targets:"
134         @echo "                   create-database create-config"
135         @echo "                   install deploy"
136         @echo "                   configure-rt create-rt"
137         @echo "                   clean help"
138         @echo
139         @echo "                   install-docs install-perl-modules"
140         @echo "                   install-init install-apache"
141         @echo "                   install-rt install-texmf"
142         @echo "                   install-selfservice update-selfservice"
143         @echo
144         @echo "                   dev dev-docs dev-perl-modules"
145         @echo
146         @echo "                   masondocs alldocs docs"
147         @echo "                   wikiman"
148         @echo "                   perl-modules"
149         #@echo
150         #@echo "                   upload-docs release"
151
152
153 masondocs: httemplate/* httemplate/*/* httemplate/*/*/* httemplate/*/*/*/*
154         rm -rf masondocs
155         cp -pr httemplate masondocs
156         touch masondocs
157
158 alldocs: masondocs
159
160 docs:
161         make masondocs
162
163 wikiman:
164         chmod a+rx ./bin/pod2x
165         ./bin/pod2x
166
167 install-docs: check-conflicts docs
168         [ -e ${FREESIDE_DOCUMENT_ROOT} ] && mv ${FREESIDE_DOCUMENT_ROOT} ${FREESIDE_DOCUMENT_ROOT}.`date +%Y%m%d%H%M%S` || true
169         cp -r masondocs ${FREESIDE_DOCUMENT_ROOT}
170         chown -R freeside:freeside ${FREESIDE_DOCUMENT_ROOT}
171         cp htetc/handler.pl ${MASON_HANDLER}
172         perl -p -i -e "\
173           s|%%%FREESIDE_EXPORT%%%|${FREESIDE_EXPORT}|g;\
174           s'%%%RT_ENABLED%%%'${RT_ENABLED}'g; \
175         " ${MASON_HANDLER} || true
176         mkdir -p ${FREESIDE_EXPORT}/profile
177         chown freeside ${FREESIDE_EXPORT}/profile
178         cp htetc/htpasswd.logout ${FREESIDE_CONF}
179         [ ! -e ${MASONDATA} ] && mkdir ${MASONDATA} || true
180         chown -R freeside ${MASONDATA}
181
182 dev-docs:
183         [ -e ${FREESIDE_DOCUMENT_ROOT} ] && mv ${FREESIDE_DOCUMENT_ROOT} ${FREESIDE_DOCUMENT_ROOT}.`date +%Y%m%d%H%M%S` || true
184         ln -s ${FREESIDE_PATH}/httemplate ${FREESIDE_DOCUMENT_ROOT}
185         cp htetc/handler.pl ${MASON_HANDLER}
186         perl -p -i -e "\
187           s'###use Module::Refresh;###'use Module::Refresh;'; \
188           s'###Module::Refresh->refresh;###'Module::Refresh->refresh;'; \
189           s|%%%FREESIDE_EXPORT%%%|${FREESIDE_EXPORT}|g;\
190           s'%%%RT_ENABLED%%%'${RT_ENABLED}'g; \
191         " ${MASON_HANDLER} || true
192
193 perl-modules:
194         cd FS; \
195         [ -e Makefile ] || perl Makefile.PL; \
196         make; \
197         perl -p -i -e "\
198           s|%%%FREESIDE_CONF%%%|${FREESIDE_CONF}|g;\
199           s|%%%FREESIDE_CACHE%%%|${FREESIDE_CACHE}|g;\
200           s'%%%FREESIDE_DOCUMENT_ROOT%%%'${FREESIDE_DOCUMENT_ROOT}'g; \
201           s'%%%RT_ENABLED%%%'${RT_ENABLED}'g; \
202           s'%%%RT_PATH%%%'${RT_PATH}'g; \
203           s'%%%MASONDATA%%%'${MASONDATA}'g;\
204           s/%%%SELFSERVICE_USER%%%/${SELFSERVICE_USER}/g;\
205         " blib/lib/FS/*.pm;\
206         perl -p -i -e "\
207           s/%%%SELFSERVICE_USER%%%/${SELFSERVICE_USER}/g;\
208           s/%%%SELFSERVICE_MACHINES%%%/${SELFSERVICE_MACHINES}/g;\
209           s|%%%FREESIDE_EXPORT%%%|${FREESIDE_EXPORT}|g;\
210         " blib/lib/FS/Cron/*.pm;\
211         perl -p -i -e "\
212           s|%%%FREESIDE_CONF%%%|${FREESIDE_CONF}|g;\
213           s|%%%FREESIDE_EXPORT%%%|${FREESIDE_EXPORT}|g;\
214           s|%%%FREESIDE_LOG%%%|${FREESIDE_LOG}|g;\
215         " blib/lib/FS/part_export/*.pm;\
216         perl -p -i -e "\
217           s|%%%FREESIDE_CACHE%%%|${FREESIDE_CACHE}|g;\
218         " blib/lib/FS/cust_main/*.pm blib/lib/FS/cust_pkg/*.pm;\
219         perl -p -i -e "\
220           s|%%%FREESIDE_CONF%%%|${FREESIDE_CONF}|g;\
221           s|%%%FREESIDE_LOG%%%|${FREESIDE_LOG}|g;\
222           s|%%%FREESIDE_LOCK%%%|${FREESIDE_LOCK}|g;\
223           s|%%%FREESIDE_CACHE%%%|${FREESIDE_CACHE}|g;\
224           s|%%%FREESIDE_EXPORT%%%|${FREESIDE_EXPORT}|g;\
225           s|%%%DIST_CONF%%%|${DIST_CONF}|g;\
226         " blib/script/*
227
228 install-perl-modules: check-conflicts perl-modules install-rt-initialdata
229         [ -L ${PERL_INC_DEV_KLUDGE}/FS ] \
230           && rm ${PERL_INC_DEV_KLUDGE}/FS \
231           && mv ${PERL_INC_DEV_KLUDGE}/FS.old ${PERL_INC_DEV_KLUDGE}/FS \
232           || true
233         cd FS; \
234         make install UNINST=1
235         #install this for freeside-setup
236         install -d $(DIST_CONF)
237         #install conf/[a-z]* $(DEFAULT_CONF)
238         #CVS is not [a-z]
239         install `ls -d conf/[a-z]* | grep -v CVS | grep -v '^conf/registries'` $(DIST_CONF)
240
241 dev-perl-modules: perl-modules
242         [ -d ${PERL_INC_DEV_KLUDGE}/FS -a ! -L ${PERL_INC_DEV_KLUDGE}/FS ] \
243           && mv ${PERL_INC_DEV_KLUDGE}/FS ${PERL_INC_DEV_KLUDGE}/FS.old \
244           || true
245
246         rm -rf ${PERL_INC_DEV_KLUDGE}/FS
247         ln -sf ${FREESIDE_PATH}/FS/blib/lib/FS ${PERL_INC_DEV_KLUDGE}/FS
248
249 install-texmf:  
250         install -D -o freeside -m 444 etc/longtable.sty \
251           ~freeside/texmf/tex/longtable.sty
252         texhash ~freeside
253
254 install-init:
255         #[ -e ${INIT_FILE} ] || install -o root -g ${INSTALLGROUP} -m 711 init.d/freeside-init ${INIT_FILE}
256         install -o root -g ${INSTALLGROUP} -m 711 init.d/freeside-init ${INIT_FILE}
257         perl -p -i -e "\
258           s/%%%QUEUED_USER%%%/${QUEUED_USER}/g;\
259           s/%%%SELFSERVICE_USER%%%/${SELFSERVICE_USER}/g;\
260           s/%%%SELFSERVICE_MACHINES%%%/${SELFSERVICE_MACHINES}/g;\
261         " ${INIT_FILE}
262         ${INIT_INSTALL}
263
264 install-apache:
265         [ -e ${APACHE_CONF}/freeside-base.conf ] && rm ${APACHE_CONF}/freeside-base.conf || true
266         [ -d ${APACHE_CONF} ] && \
267           ( install -o root -m 755 htetc/freeside-base2.conf ${APACHE_CONF} && \
268             ( [ ${RT_ENABLED} -eq 1 ] && install -o root -m 755 htetc/freeside-rt.conf ${APACHE_CONF} || true ) && \
269             ( [ ${TORRUS_ENABLED} -eq 1 ] && install -o root -m 755 htetc/freeside-torrus.conf ${APACHE_CONF} || true ) && \
270             perl -p -i -e "\
271               s'%%%FREESIDE_DOCUMENT_ROOT%%%'${FREESIDE_DOCUMENT_ROOT}'g; \
272               s'%%%FREESIDE_CONF%%%'${FREESIDE_CONF}'g; \
273               s'%%%MASON_HANDLER%%%'${MASON_HANDLER}'g; \
274             " ${APACHE_CONF}/freeside-*.conf \
275           ) || true
276         [ -d ${INSSERV_OVERRIDE} ] && [ -x /sbin/insserv ] && ( install -o root -m 755 init.d/insserv-override-apache2 ${INSSERV_OVERRIDE}/apache2 && insserv -d ) || true
277
278 install-selfservice:
279         [ -e ~freeside ] || cp -pr /etc/skel ~freeside && chown -R freeside ~freeside
280         [ -e ~freeside/.ssh/id_dsa.pub ] || [ -e ~freeside/.ssh/id_rsa.pub ] || su - freeside -c 'ssh-keygen -t dsa'
281         for MACHINE in ${SELFSERVICE_MACHINES}; do \
282           scp -r fs_selfservice/FS-SelfService ${SELFSERVICE_INSTALL_USER}@$$MACHINE:. ;\
283           ssh ${SELFSERVICE_INSTALL_USER}@$$MACHINE "cd FS-SelfService; perl Makefile.PL && make" ;\
284           ssh ${SELFSERVICE_INSTALL_USER}@$$MACHINE "cd FS-SelfService; sudo make install" ;\
285           scp ~freeside/.ssh/id_dsa.pub ${SELFSERVICE_INSTALL_USER}@$$MACHINE:. ;\
286           ssh ${SELFSERVICE_INSTALL_USER}@$$MACHINE "sudo ${SELFSERVICE_INSTALL_USERADD} freeside; sudo install -d -o freeside -m 600 ~freeside/.ssh/; sudo install -o freeside -m 600 ./id_dsa.pub ~freeside/.ssh/authorized_keys" ;\
287            ssh ${SELFSERVICE_INSTALL_USER}@$$MACHINE "sudo install -o freeside -d /usr/local/freeside" ;\
288         done
289
290 update-selfservice:
291         for MACHINE in ${SELFSERVICE_MACHINES}; do \
292           RSYNC_RSH=ssh rsync -rlptz fs_selfservice/FS-SelfService/ ${SELFSERVICE_INSTALL_USER}@$$MACHINE:FS-SelfService ;\
293           ssh ${SELFSERVICE_INSTALL_USER}@$$MACHINE "cd FS-SelfService; make clean; perl Makefile.PL && make" ;\
294           ssh ${SELFSERVICE_INSTALL_USER}@$$MACHINE "cd FS-SelfService; sudo make install" ;\
295         done
296
297 install-chown:
298         chown freeside "${FREESIDE_CACHE}/counters.${DATASOURCE}"
299         chown freeside "${FREESIDE_CACHE}/cache.${DATASOURCE}"
300         chown freeside "${FREESIDE_EXPORT}/export.${DATASOURCE}"
301
302 install: install-perl-modules install-docs install-init install-apache install-rt install-torrus install-texmf install-chown
303
304 deploy: install
305         ${HTTPD_RESTART}
306         ${FREESIDE_RESTART}
307
308 dev: dev-perl-modules dev-docs
309
310 create-database:
311         perl -e 'use DBIx::DataSource qw( create_database ); create_database( "${DATASOURCE}", "${DB_USER}", "${DB_PASSWORD}" ) or die $$DBIx::DataSource::errstr;'
312
313 create-config: install-perl-modules
314         [ -e ${FREESIDE_CONF} ] && mv ${FREESIDE_CONF} ${FREESIDE_CONF}.`date +%Y%m%d%H%M%S` || true
315         install -d -o freeside ${FREESIDE_CONF}
316
317         touch ${FREESIDE_CONF}/secrets
318         chown freeside ${FREESIDE_CONF}/secrets
319         chmod 600 ${FREESIDE_CONF}/secrets
320
321         /bin/echo -e "${DATASOURCE}\n${DB_USER}\n${DB_PASSWORD}" >${FREESIDE_CONF}/secrets
322         chmod 600 ${FREESIDE_CONF}/secrets
323         chown freeside ${FREESIDE_CONF}/secrets
324
325         mkdir "${FREESIDE_CACHE}/counters.${DATASOURCE}"
326         chown freeside "${FREESIDE_CACHE}/counters.${DATASOURCE}"
327
328         mkdir "${FREESIDE_CACHE}/cache.${DATASOURCE}"
329         chown freeside "${FREESIDE_CACHE}/cache.${DATASOURCE}"
330
331         mkdir "${FREESIDE_EXPORT}/export.${DATASOURCE}"
332         chown freeside "${FREESIDE_EXPORT}/export.${DATASOURCE}"
333
334         #install this for freeside-setup
335         install -d $(DIST_CONF)
336         #install conf/[a-z]* $(DEFAULT_CONF)
337         #CVS is not [a-z]
338         install `ls -d conf/[a-z]* | grep -v CVS | grep -v '^conf/registries'` $(DIST_CONF)
339
340
341 configure-rt:
342         cd rt; \
343         cp config.layout.in config.layout; \
344         perl -p -i -e "\
345           s'%%%FREESIDE_DOCUMENT_ROOT%%%'${FREESIDE_DOCUMENT_ROOT}'g;\
346           s'%%%MASONDATA%%%'${MASONDATA}'g;\
347         " config.layout; \
348         ./configure --enable-layout=Freeside\
349                     --with-db-type=${DB_TYPE} \
350                     --with-db-dba=${DB_USER} \
351                     --with-db-database=${RT_DB_DATABASE} \
352                     --with-db-rt-user=${DB_USER} \
353                     --with-db-rt-pass="${DB_PASSWORD}" \
354                     --with-web-user=freeside \
355                     --with-web-group=freeside \
356                     --with-rt-group=freeside \
357                     --with-web-handler=modperl2
358
359 create-rt: configure-rt
360         [ -d /opt           ] || mkdir /opt           #doh
361         [ -d /opt/rt3       ] || mkdir /opt/rt3       #
362         [ -d /opt/rt3/share ] || mkdir /opt/rt3/share #
363         cd rt; make install
364         rt/sbin/rt-setup-database --dba '${DB_USER}' \
365                                   --dba-password '${DB_PASSWORD}' \
366                                   --action schema \
367          || true
368         rt/sbin/rt-setup-database --dba-password '${DB_PASSWORD}' \
369                                   --action coredata \
370         && rt/sbin/rt-setup-database --dba-password '${DB_PASSWORD}' \
371                                      --action insert \
372                                      --datafile ${RT_PATH}/etc/initialdata \
373         || true
374
375 install-rt: check-conflicts
376         if [ ${RT_ENABLED} -eq 1 ]; then ( cd rt; make install ); fi
377         if [ ${RT_ENABLED} -eq 1 ]; then perl -p -i -e "\
378           s'%%%RT_DOMAIN%%%'${RT_DOMAIN}'g;\
379           s'%%%RT_TIMEZONE%%%'${RT_TIMEZONE}'g;\
380           s'%%%FREESIDE_URL%%%'${FREESIDE_URL}'g;\
381         " ${RT_PATH}/etc/RT_SiteConfig.pm; fi
382         if [ ${RT_ENABLED} -eq 1 ]; then \
383           chown -R freeside:freeside ${RT_PATH}/etc; fi
384
385 install-rt-initialdata:
386         if [ ${RT_ENABLED} -eq 1 ] && [ -d ${RT_PATH} ]; then \
387           chown -R freeside:freeside ${RT_PATH}/etc; \
388           install -D -o freeside -g freeside -m 0440 rt/etc/initialdata \
389           ${RT_PATH}/etc/initialdata; fi
390
391 configure-torrus:
392         cd torrus; \
393         torrus_user=freeside var_user=freeside var_group=freeside ./configure
394
395 install-torrus:
396         if [ ${TORRUS_ENABLED} -eq 1 ]; then ( cd torrus; \
397           make; \
398           make install; \
399           perl -p -i -e "\
400             s'%%%FREESIDE_URL%%%'${FREESIDE_URL}'g;\
401           " /usr/local/etc/torrus/conf/torrus-siteconfig.pl; \
402           torrus clearcache \
403         );fi
404
405 clean:
406         rm -rf masondocs
407         rm -rf httemplate/docs/man
408         rm -rf pod2htmi.tmp
409         rm -rf pod2htmd.tmp
410         -cd FS; \
411         make clean
412         -cd fs_selfservice/FS-SelfService; \
413         make clean
414
415 check-conflicts:
416         ! grep -r --exclude='*config.log*' '--exclude=*config.status*' --exclude=gnupg_details_on_output_formats '--exclude=*mason_handler*' '^=======$$' .
417
418 #these are probably only useful if you're me...
419
420 #release: upload-docs
421 .PHONY: release
422 release:
423         # Update the changelog
424         #./bin/cvs2cl
425         #cvs commit -m "Updated for ${VERSION}" ChangeLog
426
427         # Update the RPM specfile
428         #cvs edit ${RPM_SPECFILE}
429         #perl -p -i -e "s/\d+[^\}]+/${VERSION}/ if /%define\s+version\s+(\d+[^\}]+)\}/;" ${RPM_SPECFILE}
430         #perl -p -i -e "s/\d+[^\}]+/1/ if /%define\s+release\s+(\d+[^\}]+)\}/;" ${RPM_SPECFILE}
431         #cvs commit -m "Updated for ${VERSION}" ${RPM_SPECFILE}
432
433         # Update the Debian changelog
434         #cvs edit debian/changelog
435         #dch -v ${DEBVERSION} -p "New upstream release"
436         #cvs commit -m "Updated for ${VERSION}" debian/changelog
437
438         # Make sure other people's changes are pulled in!
439         git pull
440
441         # Tag the release
442         git tag -f ${TAG}
443
444         #cd /home/ivan
445         git archive --prefix=freeside-${VERSION}/ ${TAG} | gzip -9 >freeside-${VERSION}.tar.gz
446
447         scp freeside-${VERSION}.tar.gz ivan@420.am:/var/www/www.sisd.com/freeside/
448         mv freeside-${VERSION}.tar.gz ..
449
450         #these things failing should not make release target fail, so: "|| true"
451
452         #kick off vmware update
453         #./BUILD_VMWARE_APPLIANCE ${$TAG} || true
454
455         #kick off deb package update
456
457         #kick off rpm package update too?
458
459         #update web demo?
460
461         #update web demo self-service?
462