qi: Bump to version 2.4 (Release Candidate 5)
[dragora.git] / qi / src / qi.in
blobc619df8af922ba8eab851dfb8274f5e3b962aceb
1 #! /bin/sh -
2 # Copyright (C) 2016-2021 Matias Fonzo <selk@dragora.org>
4 # This program is free software: you can redistribute it and/or modify
5 # it under the terms of the GNU General Public License as published by
6 # the Free Software Foundation, either version 3 of the License, or
7 # (at your option) any later version.
9 # This program is distributed in the hope that it will be useful,
10 # but WITHOUT ANY WARRANTY; without even the implied warranty of
11 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 # GNU General Public License for more details.
14 # You should have received a copy of the GNU General Public License
15 # along with this program. If not, see <http://www.gnu.org/licenses/>.
17 # EXIT STATUS
18 # 0 = Successful completion
19 # 1 = Minor common errors (e.g: help usage, support not available)
20 # 2 = Command execution error
21 # 3 = Integrity check error for compressed files
22 # 4 = File empty, not regular, or expected
23 # 5 = Empty or not defined variable
24 # 6 = Package already installed
25 # 10 = Network manager error
27 PROGRAM="${0##*/}"
29 LC_ALL=C; # Override locale settings.
30 umask 022; # Remove write permission for group and other.
31 export LC_ALL
33 ### Functions
35 usage()
37 printf '%s' \
38 "Usage: $PROGRAM COMMAND [OPTIONS] [FILE]...
39 "'A simple but well-integrated package manager.
41 List of commands:
42 warn Warn about files that will be installed
43 install Install packages
44 remove Remove packages
45 upgrade Upgrade packages
46 extract Extract packages for debugging purposes
47 create Create a .tlz package from directory
48 build Build packages using recipe names
49 order Resolve build order through .order files
51 Options when installing, removing, or upgrading software packages:
52 -f, --force Force upgrade of pre-existing packages
53 -k, --keep Keep package directory when remove/upgrade
54 -p, --prune Prune conflicts
55 -P, --packagedir=<dir> Set directory for package installations
56 -t, --targetdir=<dir> Set target directory for symbolic links
57 -r, --rootdir=<dir> Use the fully qualified named directory as
58 the root directory for all qi operations
59 Note: the target directory and the package
60 directory will be relative to the specified
61 directory, excepting the graft log file
63 Options when building software packages using recipes:
64 -a, --architecture Set architecture name for the package
65 -j, --jobs Parallel jobs for the compiler
66 -k, --keep Keep ${srcdir} or ${destdir} when build
67 -S, --skip-questions Skip questions on completed recipes
68 -1, --increment Increment release number (${release} + 1)
69 -n, --no-package Do not create a .tlz package
70 -i, --install Install package after the build
71 -u, --upgrade Upgrade package after the build
72 -o, --outdir=<dir> Where the packages produced will be written
73 -w, --worktree=<dir> Where archives, patches, recipes are expected
74 -s, --sourcedir=<dir> Where compressed sources will be found
76 Other options:
77 -N, --no-rc Do not read the configuration file
78 -v, --verbose Be verbose (an extra -v gives more)
79 -L, --show-location Print default directory locations and exit
80 -h, --help Display this help and exit
81 -V, --version Output version information and exit
83 Some influential environment variables:
84 TMPDIR Temporary directory for sources
85 QICFLAGS C compiler flags (to be used on CFLAGS)
86 QICXXFLAGS C++ compiler flags (to be used on CXXFLAGS)
87 QILDFLAGS Flags for the linker (to be used on LDFLAGS)
88 QICPPFLAGS C/C++ preprocessor flags (to be used on CPPFLAGS)
89 SOURCE_DATE_EPOCH Last modification time for created packages
91 When FILE is -, read standard input.
93 Exit status: 0 for a normal exit, 1 for minor common errors (help usage,
94 support not available, etc), 2 to indicate a command execution error;
95 3 for integrity check error on compressed files, 4 for empty, not
96 regular, or expected files, 5 for empty or not defined variables,
97 6 when a package already exist, 10 for network manager errors.
99 Qi home page: https://www.dragora.org
103 warn()
105 printf '%s\n' "$@" 1>&2
108 is_readable()
110 if test -e "$1"
111 then
112 if ! test -r "$1"
113 then
114 echo "${PROGRAM}: cannot read ${1}: Permission denied" 1>&2
115 return 1
117 else
118 echo "${PROGRAM}: cannot access ${1}: No such file or directory" 1>&2
119 return 1
123 # Portable alternative to the file operator -nt (among shells)
124 is_newer()
126 if test -n "$(find "$1" -prune -newer "$2" -print)"
127 then
128 return 0
130 return 1
133 # Determine whether $2 matches pattern $1
134 fnmatch()
136 case $2 in
138 return 0
141 return 1
143 esac
146 chkstatus_or_exit()
148 status=$?
150 if test $status -ne 0
151 then
152 echo "^ Return status = $status" 1>&2
153 exit "${1-2}"; # If not given, defaults to 2
156 unset -v status
159 readconfig()
161 if test "${_readconfig:-readconfig}" = readconfig
162 then
163 is_readable "$HOME/.qirc" 2> /dev/null && _rcfile="$HOME/.qirc";
164 echo "Importing configuration file from \`${_rcfile}' ..."
165 . "$_rcfile" || chkstatus_or_exit 5
167 unset -v _readconfig
170 ### Mode functions
172 mode_build()
174 recipe=$1
176 echo ""
177 echo "{@} Building \"${recipe}\" ..."
179 # A recipe is any valid regular file. Qi sets priorities for reading
180 # a recipe, the order in which qi looks for a recipe is:
182 # 1. Current working directory.
184 # 2. If the specified path name does not contain "recipe" as the last
185 # component. Qi will complete it by adding "recipe" to the path
186 # name.
188 # 3. If the recipe is not in the current working directory, it will be
189 # searched under '${worktree}/recipes'. The last component will be
190 # completed adding "recipe" to the specified path name.
192 if test ! -f "$recipe"
193 then
194 if test -f "${recipe}/recipe"
195 then
196 recipe="${recipe}/recipe"
197 elif test -f "${worktree}/recipes/${recipe}/recipe"
198 then
199 recipe="${worktree}/recipes/${recipe}/recipe"
203 test -f "$recipe" || {
204 warn "\`${recipe}' is not a regular file."
205 return 4
208 # Complain if the file name is not "recipe"
210 if test "${recipe##*/}" != recipe
211 then
212 warn "\`${recipe}' is not a valid recipe name."
213 return 4
216 # Start preparations to import the recipe
218 # Get working directory and base name of the recipe
220 CWD="$(CDPATH='' cd -P -- "$(dirname -- "$recipe")" && pwd -P)"
221 recipe="$(basename -- "$recipe")"
223 # Check readability for load the recipe on success
225 is_readable "${CWD}/$recipe" || exit 4
227 # Re-create external directories
228 mkdir -p -- "${worktree}/archive" \
229 "${worktree}/patches" \
230 "${worktree}/recipes" \
231 "$tardir"
233 # Variables treatment for the current and the next recipe.
235 # Unset special variables that can only be predefined in
236 # the recipe and does not come from '${sysconfdir}/qirc'
238 unset -v \
239 srcdir destdir pkgname pkgversion pkgcategory program version release \
240 fetch description homepage license replace full_pkgname docs docsdir \
241 CFLAGS CXXFLAGS LDFLAGS CPPFLAGS
243 # The following variables must be restored, later
244 save_arch="${save_arch:=$arch}"
245 save_jobs="${save_jobs:=$jobs}"
246 save_outdir="${save_outdir:=$outdir}"
247 save_opt_nopkg="${save_opt_nopkg:=$opt_nopkg}"
249 # Reset variable values in case of return
250 arch="$save_arch"
251 jobs="$save_jobs"
252 outdir="$save_outdir"
253 opt_nopkg="$save_opt_nopkg"
255 # The following variables cannot be redefined on the recipe
256 readonly worktree netget rsync
258 # Import the recipe
260 . "${CWD}/$recipe"
261 chkstatus_or_exit
263 # Check for required variables
264 if test -z "$program"
265 then
266 warn "${recipe}: The variable 'program' is not defined."
267 exit 5
269 if test -z "$version"
270 then
271 warn "${recipe}: The variable 'version' is not defined."
272 exit 5
274 if test -z "$release"
275 then
276 warn "${recipe}: The variable 'release' is not defined."
277 exit 5
280 # Pre-settings before to start building
282 # Increment the release number if the option was given
283 if test "$opt_incr_release" = opt_incr_release
284 then
285 release=$(( release + 1 ))
288 # Allow the dot as definition for 'tardir'
289 if test "$tardir" = .
290 then
291 tardir="$CWD"
294 # Set default values for the following special variables
296 pkgname="${pkgname:=$program}"
297 pkgversion="${pkgversion:=$version}"
298 srcdir="${srcdir:=${program}-$version}"
299 destdir="${destdir:=${TMPDIR}/package-$pkgname}"
301 # If 'pkgcategory' has been defined, prefix it using the "at" symbol
302 if test -n "$pkgcategory"
303 then
304 pkgcategory="@${pkgcategory}"
307 # Compose the full package name
308 full_pkgname="${full_pkgname:=${pkgname}_${pkgversion}_${arch}-${release}${pkgcategory}}"
310 # Use 'arch' as suffix for 'outdir' to have a well-organized package output
311 outdir="${outdir}/${arch}"
313 # If a package is going to be created the existence of a
314 # previous build will be detected and reported. Under normal
315 # conditions the recipe is built as long as it is newer than
316 # the produced package, if not, we warn to the user about it.
317 # Rebuilding the package is possible (through the force ;-)
319 if test "$opt_nopkg" != opt_nopkg && \
320 { test "$opt_force" != opt_force && \
321 test -e "${outdir}/${full_pkgname}.tlz" ; }
322 then
323 if is_newer "${CWD}/$recipe" "${outdir}/${full_pkgname}.tlz"
324 then
325 warn \
326 "" \
327 "The recipe is more RECENT than the detected package:" \
328 "" \
329 "$( stat -c "%y %n" "${CWD}/$recipe" )" \
330 "$( stat -c "%y %n" "${outdir}/${full_pkgname}.tlz" )" \
331 "" \
332 " This recipe will be processed ..." \
334 elif test -e "${CWD}/post-install" && \
335 is_newer "${CWD}/post-install" "${CWD}/$recipe"
336 then
337 warn \
338 "" \
339 "The post-install script is more RECENT than the recipe:" \
340 "" \
341 "$( stat -c "%y %n" "${CWD}/post-install" )" \
342 "$( stat -c "%y %n" "${CWD}/$recipe" )" \
343 "" \
344 " The recipe will be re-processed ..." \
346 touch "${CWD}/$recipe"
347 elif test "$opt_skipqsts" = opt_skipqsts
348 then
349 warn "Recipe for '${full_pkgname}.tlz': Ignored." ""
350 return 0
351 else
352 warn \
353 "" \
354 "This recipe ALREADY produced a package:" \
355 "$( stat -c "%y %n" "${outdir}/${full_pkgname}.tlz" )" \
356 "" \
357 "The recipe is still OLDER than the produced package:" \
358 "$( stat -c "%y %n" "${CWD}/$recipe" )" \
359 "" \
360 " Probably nothing has changed." \
363 # In non-interactive mode, the user is asked about
364 # rebuilding the package. In interactive mode,
365 # the user need to pass the option explicitly
366 if test ! -t 0
367 then
368 printf '%s\n' \
369 "Do you want to rebuild this package?" \
370 "1) Yes, built it" \
371 "2) No, skip it [default]" \
372 "3) Resume, skipping completed recipes" \
373 "Enter an option number:" > /dev/tty
374 IFS= read -r ANSWER < /dev/tty || exit 2;
375 case $ANSWER in
377 echo "$ANSWER" > /dev/tty
378 unset -v ANSWER
381 unset -v ANSWER
382 echo "=== Building UNPROCESSED/MODIFIED recipes ..." > /dev/tty
383 echo ""
384 opt_skipqsts=opt_skipqsts
385 readonly opt_skipqsts
386 return 0
389 unset -v ANSWER
390 echo "Recipe for '${full_pkgname}.tlz': Cancelled." > /dev/tty
391 echo ""
392 return 0
394 esac
395 else
396 warn "Use the --force option to reprocess ${CWD}/$recipe." ""
397 return 6;
402 # Fetch remote sources
404 echo "=== Fetching remote sources if needed ..."
405 if test -n "$fetch"
406 then
407 for origin in $fetch
409 _source="${origin##*/}"
411 echo "=== Looking for \"$_source\" ..."
413 echo "=== Verifying checksum file \`${tardir}/${_source}.sha256'"
414 if test -e "${tardir}/${_source}.sha256"
415 then
416 ( cd -- "$tardir" && sha256sum - ) < "${tardir}/${_source}.sha256"
417 chkstatus_or_exit
418 continue;
419 else
420 warn "${_source}.sha256: Checksum file does not exist, yet."
423 # Download source or resume if allowed
425 if test ! -e "${tardir}/$_source"
426 then
427 warn " Can't find \"${_source}\" at \"${tardir}\";" \
428 "attempting to get it from ${origin%/*} ..."
431 case $origin in
432 rsync://*)
434 cd -- "$tardir" && $rsync "$origin" || exit $?
435 sha256sum "$_source" > "${_source}.sha256"
436 ); chkstatus_or_exit 10
438 *://*)
440 cd -- "$tardir" && $netget "$origin" || exit $?
441 sha256sum "$_source" > "${_source}.sha256"
442 ); chkstatus_or_exit 10
445 warn "${PROGRAM}: Unrecognized protocol for ${origin}."
446 exit 4
447 esac
448 done
449 unset -v origin _source
450 else
451 warn "${recipe}: The variable 'fetch' is empty."
454 # Prepare special directories for build the source,
455 # the destination and the output of the package
457 echo "=== Preparing directories ..."
459 if test -z "$keep_srcdir"
460 then
461 if test -e "${TMPDIR}/$srcdir"
462 then
463 rm -r -- "${TMPDIR:?}/$srcdir" || chkstatus_or_exit
464 echo "removed directory: '${TMPDIR}/$srcdir'"
466 else
467 warn \
468 "WARNING: The variable 'keep_srcdir' has been set (${keep_srcdir})."
471 if test -z "$keep_destdir"
472 then
473 if test -e "$destdir"
474 then
475 rm -r -- "$destdir" || chkstatus_or_exit
476 echo "removed directory: '$destdir'"
478 mkdir -p -- "$destdir" || chkstatus_or_exit
479 echo "mkdir: created directory '$destdir'"
482 if test ! -e "$outdir"
483 then
484 mkdir -p -- "$outdir" || chkstatus_or_exit
485 echo "mkdir: created directory '$outdir'"
488 echo "=== Changing to '${TMPDIR}' ..."
489 cd -- "$TMPDIR" || chkstatus_or_exit
491 # Set trap before to run the build() function in order
492 # to catch the return status, exit code 2 if fails
494 trap 'chkstatus_or_exit 2' EXIT HUP INT QUIT ABRT TERM
496 # Determine if the debugging indicators of the shell should be
497 # retained, assuming that it has been previously passed
498 case $- in *x*)
499 _xtrace_flag=_xtrace_flag_is_set ;;
500 esac
502 echo "=== Running the 'build' function ..."
503 build
504 unset -f build
506 # Check recipe to run defined functions by the packager
507 for _definition in \
508 $(awk '!/^build[ (]/ && /^[^ {}]+ *\(\)/{ gsub(/[()]/, "", $1); print $1 }' "${CWD}/$recipe")
510 # Check if it is a shell function
511 case $(LC_ALL=C type $_definition) in
512 *function*)
513 # Call and undo the function after executing it
514 $_definition
515 unset -f $_definition
517 esac
518 done
519 unset -v _definition
521 # Turn off possible shell flags coming from the recipe
523 set +e
524 if test "${_xtrace_flag:+$_xtrace_flag}" != _xtrace_flag_is_set
525 then
526 set +x
529 # Reset given signals
530 trap - EXIT HUP INT QUIT ABRT TERM
532 # If 'destdir' is empty, the package won't be created
533 if rmdir -- "$destdir" 2> /dev/null
534 then
535 warn "The package \"${full_pkgname}.tlz\" won't be created. 'destdir' is empty."
536 opt_nopkg=opt_nopkg
539 # Create (make) the package
541 if test "$opt_nopkg" != opt_nopkg
542 then
543 # Edit the recipe when 'release' is incremented
544 if test "$opt_incr_release" = opt_incr_release
545 then
546 echo ",s/^\\(release\\)=.*/\\1=${release}/"$'\nw' | \
547 ed "${CWD}/$recipe" || chkstatus_or_exit
550 mkdir -p -- "${destdir}/var/lib/qi" || chkstatus_or_exit
552 # Include a copy of the recipe into the package
553 cp -p "${CWD}/$recipe" \
554 "${destdir}/var/lib/qi/${full_pkgname}.recipe" && \
555 chmod 644 "${destdir}/var/lib/qi/${full_pkgname}.recipe"
556 chkstatus_or_exit
558 # Detect post-install script for inclusion
560 if test -f "${CWD}/post-install"
561 then
562 echo "${CWD}/post-install: Detected."
563 cp -p "${CWD}/post-install" \
564 "${destdir}/var/lib/qi/${full_pkgname}.sh" && \
565 chmod 644 "${destdir}/var/lib/qi/${full_pkgname}.sh"
566 chkstatus_or_exit
569 # Detect declared package name(s) for later replacement
571 if test -n "$replace"
572 then
573 warn \
574 "=== The following package names has been declared for replacement:" \
575 "$replace"
577 : > "${destdir}/var/lib/qi/${full_pkgname}.replace"
578 for item in $replace
580 printf '%s\n' "$replace" >> \
581 "${destdir}/var/lib/qi/${full_pkgname}.replace"
582 done
583 unset -v item
586 # Create (external) meta file for package information,
587 # make a copy of it for the package database
588 echo "=== Creating meta file ${full_pkgname}.tlz.txt ..."
589 do_meta > "${outdir}/${full_pkgname}.tlz.txt" || chkstatus_or_exit
590 cp -p "${outdir}/${full_pkgname}.tlz.txt" \
591 "${destdir}/var/lib/qi/${full_pkgname}.txt" || chkstatus_or_exit
593 # Produce the package
594 cd -- "$destdir" && mode_create "${outdir}/${full_pkgname}.tlz"
597 # Back to the current working directory
598 cd -- "$CWD" || chkstatus_or_exit
600 echo "=== Deleting 'srcdir', 'destdir' ..."
601 if test "$opt_keep" != opt_keep
602 then
603 if test -z "$keep_srcdir"
604 then
605 srcdir="${srcdir%%/*}"; # Directory name without parents.
606 if test -e "${TMPDIR}/$srcdir"
607 then
608 rm -r -- "${TMPDIR:?}/$srcdir" || chkstatus_or_exit
609 echo "removed directory: '${TMPDIR}/$srcdir'"
613 if test -z "$keep_destdir"
614 then
615 if test -e "$destdir"
616 then
617 rm -r -- "$destdir" || chkstatus_or_exit
618 echo "removed directory: '$destdir'"
621 else
622 warn \
623 " Request via --keep to preserve 'srcdir' or 'destdir' has been made:" \
624 "${TMPDIR}/$srcdir" \
625 "$destdir"
628 # Install or upgrade the package after build
629 if test "$opt_nopkg" != opt_nopkg
630 then
631 if test "$opt_install" = opt_install
632 then
633 mode_install "${outdir}/${full_pkgname}.tlz"
634 elif test "$opt_upgrade" = opt_upgrade
635 then
636 mode_upgrade "${outdir}/${full_pkgname}.tlz"
640 echo "{@} All done for \"${CWD}/${recipe}\"."
641 echo ""
644 mode_create()
646 directory="$(dirname -- "$1")"
648 # Perform sanity checks
650 if ! fnmatch '/?*' "$directory"
651 then
652 warn "${PROGRAM}: Output directory \`${directory}' is not fully qualified"
653 exit 4
655 is_readable "$directory" || exit 4
657 name="$(basename -- "$1")"
659 echo ""
660 echo "{#} Creating package name \`${name}' ..."
662 if test "$name" = "${name%.tlz}"
663 then
664 warn "Package format '$name' not supported." \
665 "It should be \"name_version_architecture-release[@pkgcategory].tlz\""
666 exit 4
669 # Pass extra options for tarlz(1)
670 if test -n "$SOURCE_DATE_EPOCH"
671 then
672 tarlz_opts="--mtime=@${SOURCE_DATE_EPOCH}"
675 ( umask 022 ; tarlz --solid -9 $tarlz_opts -cvf - -- * ) \
676 > "${directory}/$name"
677 chkstatus_or_exit 3
678 unset -v tarlz_opts
680 ( cd -- "$directory" && sha256sum "$name" > "${name}.sha256" )
681 chkstatus_or_exit 4
683 echo "{#} Package \"${name}\" created on ${directory}."
685 # Remove used variables
686 unset -v directory name
688 echo ""
691 mode_remove()
693 expunge="${packagedir}/$(basename -- "$1" .tlz)"
695 echo ""
696 echo "<<< Removing package \`$rootdir${expunge}' ..."
698 # Complain if the package directory does not exist
700 test -e "$rootdir${expunge}" || {
701 warn "Package directory '$rootdir${expunge}' does not exist."
702 return 4
705 # Complain if the package directory cannot be well-read
707 is_readable "$rootdir${expunge}" || exit 4
709 # Remove package from Graft control
711 # Scan for possible conflicts, stop if arise
712 if test "$opt_prune" != opt_prune
713 then
714 echo "=== Checking for possible conflicts ..."
715 if graft -d -n $graft_r -t "$targetdir" "$expunge" 2>&1 | \
716 grep "^CONFLICT"
717 then
718 warn "" \
719 " A conflict occurred during uninstallation;" \
720 "Unless the --prune option is given, this package will be PRESERVED."
721 return 6;
725 # Remove objects (files, links or directories) from the target
726 # directory that are in conflict with the package directory
728 echo "=== Pruning any conflict ..."
729 graft -p -D -u $graft_r -t "$targetdir" "$expunge"
730 chkstatus_or_exit 2
732 echo "=== Disabling links ..."
733 graft -d -D -u $graft_v $graft_r -t "$targetdir" "$expunge"
734 chkstatus_or_exit 2
736 # Delete package directory
737 if test "$opt_keep" != opt_keep
738 then
739 echo "=== Deleting package directory, if exists as such ..."
740 if test -e "${rootdir}$expunge"
741 then
742 rm -r -- "${rootdir}$expunge" || chkstatus_or_exit
743 echo "removed directory: '${rootdir}$expunge'"
747 # Remove used variables
748 unset -v expunge
750 echo ""
753 mode_install()
755 # Complain if the package cannot be well-read
757 is_readable "$1" || exit 4
759 # Complain if the package does not end in .tlz
761 if ! fnmatch '*.tlz' "$1"
762 then
763 warn "\`${1}' does not end in .tlz"
764 return 4
767 # Make preparations to install the package
769 # Get the filename
770 name="$(basename -- "$1" .tlz)"
772 echo ""
773 echo ">>> Installing package \`${name}' ..."
775 echo "=== Checking tarball integrity ..."
776 tarlz --missing-crc -tf "$1" > /dev/null
777 chkstatus_or_exit 3
779 # To accept random directory from the upgrade mode
780 _packagedir="$2"
781 _packagedir="${_packagedir:=$packagedir}"
783 # Create package directory using 'name'
784 if ! test -d "$rootdir${_packagedir}/$name"
785 then
786 mkdir -p -- "$rootdir${_packagedir}/$name" || chkstatus_or_exit
787 echo "mkdir: created directory '$rootdir${_packagedir}/$name'"
790 # Scan for possible conflicts, stop if arise
791 if test "$opt_prune" != opt_prune
792 then
793 echo "=== Checking for possible conflicts ..."
794 if graft -i -n $graft_r -t "$targetdir" "${_packagedir}/$name" 2>&1 | \
795 grep "^CONFLICT"
796 then
797 warn "" \
798 " A conflict occurred during installation;" \
799 "Unless the --prune option is given, this package won't be LINKED."
800 return 6;
804 echo "=== Decompressing package ..."
805 ( cd -- "$rootdir${_packagedir}/$name" && tarlz -xpf - ) < "$1"
806 chkstatus_or_exit 3
808 # Transite package to Graft control
810 # Remove objects (files, links or directories) from the target
811 # directory that are in conflict with the package directory
812 echo "=== Pruning any conflict ..."
813 graft -p -D -u $graft_r -t "$targetdir" "${_packagedir}/$name"
814 chkstatus_or_exit 2
816 echo "=== Enabling symbolic links ..."
817 graft -i -P $graft_v $graft_r -t "$targetdir" "${_packagedir}/$name"
818 chkstatus_or_exit 2
820 # Avoid unnecessary runs coming from the upgrade mode,
821 # this is when the incoming package is **pre-installed**
823 if test "$_isUpgrade" != _isUpgrade.on
824 then
825 # Show package description
826 if test -r "$rootdir${_packagedir}/${name}/var/lib/qi/${name}.txt"
827 then
828 awk '/^#/' "$rootdir${_packagedir}/${name}/var/lib/qi/${name}.txt"
829 elif test -r "${1}.txt"
830 then
831 # From external meta file (current directory)
832 awk '/^#/' "${1}.txt"
833 else
834 warn "Description file not found for '$name'."
837 # Check and run the post-install script if exist
838 if test -r "$rootdir${_packagedir}/${name}/var/lib/qi/${name}.sh"
839 then
840 echo "=== Running post-install script for \`${name}' ..."
842 # Rely on 'targetdir' if 'rootdir' is empty
843 cd -- "${rootdir:=$targetdir}"/ && \
844 . "$rootdir${_packagedir}/${name}/var/lib/qi/${name}.sh"
848 # Check if there are declared packages for replacement
849 if test -r "$rootdir${_packagedir}/${name}/var/lib/qi/${name}.replace"
850 then
851 while read -r line
853 for replace in "$rootdir${_packagedir}/${line%%_*}"_*
855 if ! test -e "$replace"
856 then
857 warn "<^> Declared package \`${replace}' does not exist. (ignoring)"
858 continue;
861 replace="${replace##*/}"
863 # The search for the package to be replaced cannot
864 # be the same to the incoming package, even to the
865 # temporary location coming from the upgrade mode
866 if test "$replace" = "$name" || \
867 test "_x_${replace}" = "_x_${PRVLOC##*/}"
868 then
869 continue;
872 warn "WARNING: Replacing package \`${replace}' ..."
874 # Since the links belongs to the new package, only
875 # those which are not in conflict can be deleted.
876 # To complete, we will remove the package directory
878 graft -d -D -u $graft_r \
879 -t "$targetdir" "$replace" > /dev/null 2>&1
881 rm -rf -- "$rootdir${_packagedir}/$replace"
882 done
883 done < "$rootdir${_packagedir}/${name}/var/lib/qi/${name}.replace"
887 # Remove used variables
888 unset -v name _packagedir
890 echo ""
893 mode_order()
895 # Complain if the file cannot be well-read
897 is_readable "$1" || exit 4
899 # Complain if the file does not end in .order
901 if ! fnmatch '*.order' "$1"
902 then
903 warn "\`${1}' does not end in .order"
904 return 4
907 # Get a clean list of the file while printing its contents in
908 # reverse order. Last awk(1) in the pipeline eliminates
909 # non-consecutive lines: duplicates, blank lines, and colons.
910 # Comment lines beginning with '#' are allowed; parentheses
911 # are simply ignored
913 awk '{
914 gsub( /:|^#(.*)$|\([^)]*)|^$/,"" );
915 for( i=NF; i > 0; i-- ) print $i
916 }' "$1" | awk '!s[$0]++'
919 mode_upgrade()
921 # Complain if the package does not end in .tlz
923 if ! fnmatch '*.tlz' "$1"
924 then
925 warn "\`${1}' does not end in .tlz"
926 return 4
929 # Get the filename
930 incoming="$(basename -- "$1" .tlz)"
932 echo ""
933 echo "{%} Upgrading package \`${incoming}' ..."
935 # Check package pre-existence
936 if test "$opt_force" != opt_force && \
937 test -e "$rootdir${packagedir}/$incoming"
938 then
939 warn \
940 "" \
941 " The package to be upgraded already exist;" \
942 "Unless the --force option is given, this package won't be UPGRADED."
943 return 6;
946 # Ignore some signals until the upgrade process is complete
947 trap "" HUP INT QUIT ABRT TERM
949 # Check blacklisted packages
951 echo "=== Checking blacklist ..."
952 for item in $blacklist
954 case $item in
955 ${incoming}*)
956 warn \
957 "Package name declared on the blacklist \"${incoming}\"." \
958 "" \
959 " This package will be INSTALLED instead of being upgraded."
960 opt_prune=opt_prune mode_install "$1"
961 return 0
963 esac
964 done
965 unset -v item
967 # Prepare the package to install it in a temporary but custom location
969 # Set random directory under 'rootdir/packagedir' using 'incoming' as name
970 PRVLOC=$(mktemp -dp "$rootdir${packagedir}" ${incoming}.XXXXXXXXXXXX) || exit 2
972 echo "=== Pre-installing package in temporary location ..."
973 opt_prune=opt_prune # Turn on prune operation.
974 _isUpgrade=_isUpgrade.on mode_install "$1" "$PRVLOC" > /dev/null
975 _isUpgrade=_isUpgrade.off
977 echo "=== Looking for installations under the same name ..."
978 for long_name in "$rootdir${packagedir}/${incoming%%_*}"_*
980 # Check if it is a valid directory and if the incoming
981 # package is not equivalent to a previous installation;
982 # also check if the package to be deleted is equivalent
983 # to the temporary, private location.
985 if ! test -d "$long_name"
986 then
987 continue;
989 if test "${long_name##*/}" = "$incoming"
990 then
991 continue;
993 if test "$long_name" = "$PRVLOC"
994 then
995 continue;
998 warn "Proceeding to the removal of ${long_name} ..."
999 # A package directory will be preserved if --keep is given
1000 mode_remove "${long_name##*/}" > /dev/null
1001 done
1002 unset -v long_name
1004 # Re-install the package removing the temporary location
1006 mode_install "$1"
1007 opt_prune=opt_prune.off # Turn off prune operation.
1009 echo "=== Deleting temporary location ..."
1010 rm -rf -- "$PRVLOC" || chkstatus_or_exit
1011 echo "removed directory: '$PRVLOC'"
1013 echo "{%} Upgraded from \"${1}\"."
1015 # Remove remaining variables
1016 unset -v incoming PRVLOC
1018 echo ""
1020 # Reset given signals
1021 trap - HUP INT QUIT ABRT TERM
1024 mode_warn()
1026 # Complain if the package cannot be well-read
1028 is_readable "$1" || exit 4
1030 # Complain if the package does not end in .tlz
1032 if ! fnmatch '*.tlz' "$1"
1033 then
1034 warn "\`${1}' does not end in .tlz"
1035 return 4
1038 # List content of files excluding directories
1039 while test -f "$1"
1041 tarlz -tvvf "$1" | awk '!/^drwx/'
1042 chkstatus_or_exit 3
1043 shift;
1044 done
1045 return 0
1048 mode_extract()
1050 # Perform sanity checks before package extraction
1052 is_readable "$1" || exit 4
1054 test -f "$1" || {
1055 warn "\`${1}' is not a regular file."
1056 return 4
1059 # Preparations to extract the package
1061 name="$(basename -- "$1" .tlz)"
1063 # Set random directory under 'TMPDIR' using 'name'
1064 PRVDIR=$(mktemp -dp "$TMPDIR" ${name}.XXXXXXXXXXXX) || exit 2
1066 # Trap to remove 'PRVDIR' on disruptions
1067 trap 'rm -rf -- "$PRVDIR"' HUP INT ABRT TERM
1069 # Create 'PRVDIR' removing access for all but user
1070 ( umask 077 ; mkdir -- "$PRVDIR" )
1071 mkdir -p -- "$PRVDIR"
1072 chmod 700 -- "$PRVDIR"
1074 echo ""
1075 echo "--- Extracting package \`${name}' ..."
1077 ( umask 000 ; cd -- "$PRVDIR" && tarlz -xvf - ) < "$1"
1078 if test $? -ne 0
1079 then
1080 # Try to remove (empty) 'PRVDIR' on failure
1081 rmdir -- "$PRVDIR"
1082 exit 3;
1085 echo ""
1086 echo "\"${name}\" has been extracted on \`${PRVDIR}'"
1088 # Reset given signals
1089 trap - HUP INT ABRT TERM
1091 # Remove used variables
1092 unset -v name PRVDIR
1095 ### Extra functions to be used during the modes
1097 unpack()
1099 for file in "$@"
1101 case $file in
1102 *.tar)
1103 tar -tf "$file" > /dev/null && \
1104 tar -xpf "$file"
1105 chkstatus_or_exit 3
1107 *.tar.gz | *.tgz | *.tar.Z )
1108 gzip -cd "$file" | tar -tf - > /dev/null && \
1109 gzip -cd "$file" | tar -xpf -
1110 chkstatus_or_exit 3
1112 *.tar.bz2 | *.tbz2 | *.tbz )
1113 bzip2 -cd "$file" | tar -tf - > /dev/null && \
1114 bzip2 -cd "$file" | tar -xpf -
1115 chkstatus_or_exit 3
1117 *.tar.lz | *.tlz )
1118 lzip -cd "$file" | tar -tf - > /dev/null && \
1119 lzip -cd "$file" | tar -xpf -
1120 chkstatus_or_exit 3
1122 *.tar.xz | *.txz )
1123 xz -cd "$file" | tar -tf - > /dev/null && \
1124 xz -cd "$file" | tar -xpf -
1125 chkstatus_or_exit 3
1127 *.zip | *.ZIP )
1128 unzip -t "$file" > /dev/null && \
1129 unzip "$file" > /dev/null
1130 chkstatus_or_exit 3
1132 *.gz)
1133 gzip -t "$file" && \
1134 gzip -cd "$file" > "$(basename -- "$file" .gz)"
1135 chkstatus_or_exit 3
1137 *.Z)
1138 gzip -t "$file" && \
1139 gzip -cd "$file" > "$(basename -- "$file" .Z)"
1140 chkstatus_or_exit 3
1142 *.bz2)
1143 bzip2 -t "$file" && \
1144 bzip2 -cd "$file" > "$(basename -- "$file" .bz2)"
1145 chkstatus_or_exit 3
1147 *.lz)
1148 lzip -t "$file" && \
1149 lzip -cd "$file" > "$(basename -- "$file" .lz)"
1150 chkstatus_or_exit 3
1152 *.xz)
1153 xz -t "$file" && \
1154 xz -cd "$file" > "$(basename -- "$file" .xz)"
1155 chkstatus_or_exit 3
1158 warn "${PROGRAM}: cannot unpack ${file}: Unsupported extension"
1159 exit 1
1160 esac
1161 done
1162 unset -v file
1165 do_meta()
1167 # Extract information from the recipe to create the meta file.
1169 # The package description is pre-formatted in 78 columns,
1170 # the '#' character and a space is added as prefix to conform
1171 # the 80 columns in total
1173 printf '%s\n' "$description" | fold -w 78 | awk '$0="# " $0'
1174 printf '%s' \
1176 QICFLAGS=\"$QICFLAGS\"
1177 QICXXFLAGS=\"$QICXXFLAGS\"
1178 QILDFLAGS=\"$QILDFLAGS\"
1179 QICPPFLAGS=\"$QICPPFLAGS\"
1180 pkgname=$pkgname
1181 pkgversion=$pkgversion
1182 arch=$arch
1183 release=$release
1184 pkgcategory=\"${pkgcategory#@*}\"
1185 full_pkgname=$full_pkgname
1186 blurb=\"$(printf '%s\n' "$description" | sed -e '/^$/d;2q')\"
1187 homepage=\"$homepage\"
1188 license=\"$license\"
1189 fetch=\"$fetch\"
1190 replace=\"$replace\"
1194 ### Default values
1196 packagedir=@PACKAGEDIR@
1197 targetdir=@TARGETDIR@
1198 blacklist="perl5 graft tarlz plzip musl glibc coreutils bash mksh"
1199 _rcfile=@SYSCONFDIR@/qirc
1200 opt_install=opt_install.off
1201 opt_upgrade=opt_upgrade.off
1202 opt_force=opt_force.off
1203 opt_keep=opt_keep.off
1204 opt_incr_release=opt_incr_release.off
1205 opt_skipqsts=opt_skipqsts.off
1206 opt_nopkg=opt_nopkg.off
1207 opt_prune=opt_prune.off
1208 verbose=0
1209 rootdir=""
1210 arch=@ARCH@
1211 jobs=1
1212 mode=""
1213 _xtrace_flag=""
1214 _readstdin=""
1215 graft_v=""
1216 graft_r=""
1217 _isUpgrade=_isUpgrade.off
1218 keep_srcdir=""
1219 keep_destdir=""
1220 TMPDIR="${TMPDIR:-/usr/src/qi/build}"
1221 QICFLAGS="${QICFLAGS:--O2}"
1222 QICXXFLAGS="${QICXXFLAGS:--O2}"
1223 QILDFLAGS="${QILDFLAGS:-}"
1224 QICPPFLAGS="${QICPPFLAGS:-}"
1225 worktree=/usr/src/qi
1226 tardir=${worktree}/sources
1227 outdir=/var/cache/qi/packages
1228 netget="wget -c -w1 -t3 --no-check-certificate"
1229 rsync="rsync -v -a -L -z -i --progress"
1230 configure_args="--prefix=@PREFIX@ --libexecdir=@LIBEXECDIR@ --bindir=@BINDIR@ --sbindir=@SBINDIR@ --sysconfdir=@SYSCONFDIR@ --localstatedir=@LOCALSTATEDIR@"
1231 infodir=@INFODIR@
1232 mandir=@MANDIR@
1233 docdir=@DOCDIR@
1235 # Store (default) directory locations
1236 QI_TARGETDIR=$targetdir
1237 QI_PACKAGEDIR=$packagedir
1238 QI_WORKTREE=$worktree
1239 QI_TARDIR=$tardir
1240 QI_OUTDIR=$outdir
1242 ### Parse commands and options
1244 validate_mode()
1246 if test -n "$mode"
1247 then
1248 warn "${PROGRAM}: First defined command: ${mode#*_}" \
1249 "Switching to another command is not allowed (${1})."
1250 exit 1
1254 validate_option()
1256 if test -z "$2"
1257 then
1258 warn "${PROGRAM}: The '${1}' option requires an argument" \
1259 "Try '${PROGRAM} --help' for more information."
1260 exit 1
1264 validate_directory()
1266 if test ! -d "$2"
1267 then
1268 warn "${PROGRAM}: ${1} \"${2}\" must be a valid directory name"
1269 exit 1
1273 validate_digit()
1275 name="$1"
1276 shift
1278 # Taken from https://mywiki.wooledge.org/BashFAQ/054
1279 case "${1#[-+]}" in
1281 warn "${PROGRAM}: The '${name}' option has no defined value"
1282 exit 1
1284 *.*.*)
1285 warn "${PROGRAM}: The '${name}' option has more than one decimal point on it \"${1}\""
1286 exit 1
1288 *[!0-9]*)
1289 warn "${PROGRAM}: The '${name}' option contains a non-valid digit on it \"${1}\""
1290 exit 1
1292 esac
1294 unset -v name
1297 while test $# -gt 0
1299 case $1 in
1300 warn)
1301 validate_mode warn
1302 mode=mode_warn
1304 install)
1305 validate_mode install
1306 readconfig
1307 mode=mode_install
1309 remove)
1310 validate_mode remove
1311 readconfig
1312 mode=mode_remove
1314 upgrade)
1315 validate_mode upgrade
1316 readconfig
1317 mode=mode_upgrade
1319 extract)
1320 validate_mode extract
1321 readconfig
1322 mode=mode_extract
1324 create)
1325 validate_mode create
1326 readconfig
1327 mode=mode_create
1329 order)
1330 validate_mode order
1331 readconfig
1332 mode=mode_order
1334 build)
1335 validate_mode build
1336 readconfig
1337 mode=mode_build
1339 --no-rc | -N )
1340 _readconfig=readconfig.off
1342 --install | -i )
1343 opt_install=opt_install
1345 --upgrade | -u )
1346 opt_upgrade=opt_upgrade
1348 --force | -f )
1349 opt_force=opt_force
1351 --keep | -k )
1352 opt_keep=opt_keep
1354 --prune | -p )
1355 opt_prune=opt_prune
1357 --packagedir | -P )
1358 validate_option "$1" "$2"
1359 packagedir="$2"
1360 validate_directory "$1" "$packagedir"
1361 shift
1363 --packagedir=*)
1364 validate_option "$1" "$2"
1365 packagedir="${1#*=}"
1366 validate_directory "$1" "$packagedir"
1368 --targetdir | -t )
1369 validate_option "$1" "$2"
1370 targetdir="$2"
1371 validate_directory "$1" "$targetdir"
1372 shift
1374 --targetdir=*)
1375 validate_option "$1" "$2"
1376 targetdir="${1#*=}"
1377 validate_directory "$1" "$targetdir"
1379 --rootdir | -r )
1380 validate_option "$1" "$2"
1381 rootdir="$2"
1382 validate_directory "$1" "$rootdir"
1383 shift
1385 --rootdir=*)
1386 validate_option "$1" "$2"
1387 rootdir="${1#*=}"
1388 validate_directory "$1" "$rootdir"
1390 --outdir | -o )
1391 validate_option "$1" "$2"
1392 outdir="$2"
1393 validate_directory "$1" "$outdir"
1394 shift
1396 --outdir=*)
1397 validate_option "$1" "$2"
1398 outdir="${1#*=}"
1399 validate_directory "$1" "$outdir"
1401 --worktree | -w )
1402 validate_option "$1" "$2"
1403 worktree="$2"
1404 validate_directory "$1" "$worktree"
1405 shift
1407 --worktree=*)
1408 validate_option "$1" "$2"
1409 worktree="${1#*=}"
1410 validate_directory "$1" "$worktree"
1412 --sourcedir | -s )
1413 validate_option "$1" "$2"
1414 tardir="$2"
1415 validate_directory "$1" "$tardir"
1416 shift
1418 --sourcedir=*)
1419 validate_option "$1" "$2"
1420 tardir="${1#*=}"
1421 validate_directory "$1" "$tardir"
1423 --architecture | -a )
1424 validate_option "$1" "$2"
1425 arch="$2"
1426 shift
1428 --arch=*)
1429 validate_option "$1" "$2"
1430 arch="${1#*=}"
1432 --jobs | -j )
1433 jobs="$2"
1434 validate_digit "$1" "$jobs"
1435 shift
1437 -j[0-9]*)
1438 jobs="${1#-j*}"
1439 validate_digit '-j' "$jobs"
1441 --jobs=*)
1442 jobs="${1#*=}"
1443 validate_digit '--jobs=' "$jobs"
1445 --no-package | -n )
1446 opt_nopkg=opt_nopkg
1448 --increment | -1 )
1449 opt_incr_release=opt_incr_release
1451 --skip-questions | -S )
1452 opt_skipqsts=opt_skipqsts
1454 --verbose | -v )
1455 verbose=$(( verbose + 1 ))
1457 -vv)
1458 # ^ Trick for a second -v.
1459 verbose=2
1461 --show-location | -L )
1462 printf '%s\n' \
1463 "QI_TARGETDIR=$QI_TARGETDIR" \
1464 "QI_PACKAGEDIR=$QI_PACKAGEDIR" \
1465 "QI_WORKTREE=$QI_WORKTREE" \
1466 "QI_TARDIR=$QI_TARDIR" \
1467 "QI_OUTDIR=$QI_OUTDIR"
1468 exit 0
1470 --help | --hel | --he | --h | '--?' | -help | -hel | -he | -h | '-?' | \
1471 help )
1472 usage
1473 exit 0
1475 --version | --versio | --versi | --vers | \
1476 -version | -versio | -versi | -vers | -V | version )
1477 echo "$PROGRAM version @VERSION@"
1478 exit 0
1480 '-')
1481 _readstdin=readstdin
1482 break
1485 shift
1486 break; # End of options.
1489 warn "qi: Unrecognized option: $1" \
1490 "Try '${PROGRAM} --help' for more information."
1491 exit 1
1494 break; # No more options.
1496 esac
1497 shift
1498 done
1499 unset -f \
1500 readconfig validate_mode validate_option validate_directory validate_digit
1502 # When there are no arguments, show the help
1503 if test $# -eq 0
1504 then
1505 usage
1506 exit 1
1508 unset -f usage
1510 # Program sanity check
1512 for need in awk basename chmod cp dirname find fold graft grep \
1513 mkdir mktemp rm rmdir sed sha256sum stat tarlz ; \
1515 if ! \command -v $need > /dev/null
1516 then
1517 warn "${PROGRAM}: Prerequisite \`${need}' not found in PATH"
1518 exit 2
1520 done
1521 unset -v need
1523 # Set verbosity level/flag
1525 if test "$verbose" -gt 0
1526 then
1527 if test "$verbose" -eq 1
1528 then
1529 graft_v=-v
1530 else
1531 graft_v=-V
1535 # Read standard input if FILE is -, or when
1536 # FILE is not connected to a terminal
1538 if test "$_readstdin" = readstdin
1539 then
1540 if test -t 0
1541 then
1542 warn "qi: I won't read from a connected terminal." \
1543 "Try '${PROGRAM} --help' for more information."
1544 exit 1
1547 # Unset positional parameters setting $# to zero
1548 set --
1550 # Assign remaining arguments to the positional parameters
1551 while read -r input
1553 set -- "$@" "$input"
1554 done
1556 unset -v _readstdin
1558 if test -z "$mode"
1559 then
1560 warn "qi: We need at least one (valid) command." \
1561 "Try '${PROGRAM} --help' for more information."
1562 exit 4
1565 # Validate 'packagedir' and 'targetdir' as canonical directories
1567 # The single slash '/' does not qualify here
1568 if ! fnmatch '/?*' "$packagedir"
1569 then
1570 warn "${PROGRAM}: Package directory \`${packagedir}' is not fully qualified"
1571 exit 4
1573 if test ! -d "$packagedir"
1574 then
1575 warn "${PROGRAM}: Package directory \`${packagedir}' does not exist"
1576 exit 4
1579 # The single slash '/' is valid here
1580 if ! fnmatch '/*' "$targetdir"
1581 then
1582 warn "${PROGRAM}: Target directory \`${targetdir}' is not fully qualified"
1583 exit 4
1585 if test ! -d "$targetdir"
1586 then
1587 warn "${PROGRAM}: Target directory \`${targetdir}' does not exist"
1588 exit 4
1591 # Validate 'rootdir' directory
1593 if test -n "$rootdir"
1594 then
1595 if test -d "$rootdir" && test "$rootdir" != /
1596 then
1597 rootdir="${rootdir%/}" # Remove slash from the end.
1599 # A workaround for graft-2.13+. The specified directory is
1600 # relative to the log file, we prepend it inside 'rootdir'
1602 eval "$(graft -L)" ; GRAFT_LOGFILE="${GRAFT_LOGFILE:=/var/log/graft}"
1603 mkdir -p -- "$rootdir$(dirname -- "$GRAFT_LOGFILE")" || chkstatus_or_exit
1605 # Compose 'rootdir' and log file option to be used with graft(1)
1606 graft_r="-r $rootdir -l $GRAFT_LOGFILE"
1608 # Unset variables coming from eval
1609 unset -v GRAFT_PERL GRAFT_LOGFILE GRAFT_TARGETDIR GRAFT_PACKAGEDIR
1610 else
1611 warn "${PROGRAM}: Root directory \`${rootdir}' is not fully qualified"
1612 exit 4
1614 readonly rootdir
1615 export rootdir
1618 # Ensure 'TMPDIR' creation to prefix temporary files
1620 if test ! -d "$TMPDIR"
1621 then
1622 mkdir -p -- "$TMPDIR" || chkstatus_or_exit
1624 readonly TMPDIR packagedir targetdir
1626 # Process each package or recipe provided on the command-line
1628 for package in "$@"
1630 $mode "$package"
1631 done