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