contrib/pactree

   1 #!/bin/bash
   2 # pactree : a simple dependency tree viewer
   3 #
   4 # Copyright (C) 2008 Carlo "carlocci" Bersani <carlocci@gmail.com>
   5 #
   6 # This program is free software; you can redistribute it and/or
   7 # modify it under the terms of the GNU General Public License
   8 # as published by the Free Software Foundation; either version 2
   9 # of the License, or (at your option) any later version.
  10 #
  11 # This program is distributed in the hope that it will be useful,
  12 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 # GNU General Public License for more details.
  15 #
  16 # You should have received a copy of the GNU General Public License
  17 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
  18
  19 # Original http://carlocci.ngi.it/arch/pactree
  20 # Credit to scj for the graphviz idea
  21
  22 # set the colors
  23 branch1_color="\033[0;33m"    #Brown
  24 branch2_color="\033[0;37m"    #Gray
  25 leaf_color="\033[1;32m"       #Light green
  26 leaf2_color="\033[0;32m"      #Green
  27
  28 # set the separators
  29 separator="   "
  30 branch_tip1="|--"
  31 branch_tip2="+--"
  32 provides="provides "
  33
  34 # set the graphviz options
  35 # http://www.graphviz.org/doc/info/output.html for available output formats
  36 # http://www.graphviz.org/doc/info/colors.html for available colors
  37 gformat="png"                 #output format
  38 start_color="red"             #START color
  39 nodes_color="green"           #color of the nodes
  40 arrow1_color="chocolate4"     #color of the normal arrow
  41 arrow2_color="grey"           #color of the "provided by" headless arrow
  42
  43 readonly prog_name="pactree"
  44 readonly prog_ver="0.2"
  45
  46 _usage(){
  47         echo "This program generates the dependency tree of an installed package"
  48         echo "Usage:   $prog_name [OPTIONS] <installed packages>"
  49         echo
  50         echo " OPTIONS:"
  51         echo "  -c, --color                Enable color output"
  52         echo "  -d, --depth INT            Limit the shown dependencies depth"
  53         echo "  -g, --graph                Use graphviz to make an image of the tree"
  54         echo "  -l, --linear               Enable linear output"
  55         echo "  -s, --silent               Shh, let me hear those errors!"
  56         echo "  -u, --unique               Print the dependency list with no duplicates"
  57         echo
  58         echo "  -h, --help                 Print this help message"
  59         echo "  -v, --version              Print the program name and version"
  60         echo
  61         echo "Example: $prog_name -c -d 2 readline"
  62 }
  63
  64 _version(){
  65         echo "$prog_name version $prog_ver"
  66         echo "Copyright (C) 2008 Carlo \"carlocci\" Bersani <carlocci@gmail.com>"
  67 }
  68 # end of the friendliness
  69
  70
  71 # grab a field from the database: $1=path/to/file, $2=field to grab
  72 _grabfield(){
  73         for line in $(cat "$1" 2>/dev/null ); do
  74                 if [ -z "$line" ]; then
  75                         continue;
  76                 fi;
  77                 if [[ "$line" =~ %[A-Z]*% ]]; then
  78                         current="$line"
  79                         continue;
  80                 fi;
  81                 if [ "$current" = "$2" ]; then
  82                         echo "$line"
  83                 fi;
  84         done
  85 }
  86
  87
  88 # find a dep in the db: $1=dep, $2=field, $3=dbfile, ret=file list
  89 _finddep(){
  90         for line in $(awk 'BEGIN{RS=""}
  91                            {
  92                            if ($1=="'"$2"'"){
  93                              for (i=2 ; i<=NF ; ++i){
  94                                if ($i ~ /^'"$1"'([<>=]+.*|)$/ ){
  95                                  print FILENAME}
  96                                }
  97                              }
  98                            }' $(find $pac_db -name $3)); do
  99                 echo "${line%/*}"
 100         done
 101 }
 102
 103
 104 # Recursive function: does all of the work, pays all of the taxes     #
 105 _tree(){
 106         pkg_name="$1"
 107         pkg_dirs="$(echo $pac_db/$pkg_name-[0-9]*)"
 108
 109         # Is $pkg_name real or provided?
 110         [ ! -d "$pkg_dirs" ] && pkg_dirs="$(_finddep $pkg_name %PROVIDES% depends)"
 111
 112         for pkg_dir in $pkg_dirs ; do
 113                 spaces="$2"
 114                 unset provided
 115                 branch_tip="$branch_tip1"
 116                 branch_color="$branch1_color"
 117                 pkg_name="$(_grabfield "$pkg_dir/desc" %NAME%)"
 118                 if [ ! "$pkg_name" = "$1" ]; then
 119                         provided="$leaf2_color $provides$leaf_color$1"
 120                         branch_tip="$branch_tip2"
 121                         branch_color="$branch2_color"
 122                         if [ $graphviz -eq 1 ] && [[ ! "${dep_list[@]}" =~ _$1_ ]] && [ $spaces -ne $((max_depth+1)) ]; then
 123                                 echo "\"$1\" -> \"$pkg_name\" [arrowhead=none, color=$arrow2_color];"
 124                                 dep_list=( "${dep_list[@]}" "_$1_" )
 125                                 _tree "$pkg_name" $((spaces+1))
 126                                 continue
 127                         fi
 128                 fi
 129
 130                 # Generate the spacer
 131                 spacer=""
 132                 for each in $(seq 1 $spaces); do
 133                         spacer="$spacer$separator"
 134                 done
 135                 spacer="$spacer$branch_tip"
 136
 137                 [ $silent -ne 1 ] &&    echo -e "$branch_color$spacer$leaf_color$pkg_name$provided"
 138
 139                 [ ! -d "$pkg_dir" ] && echo "No $pkg_name in the database (inconsistent database?)" >&2
 140
 141                 if [[ ! " ${dep_list[@]} " =~ " $pkg_name " ]] && [ $spaces -ne $max_depth ]; then
 142                         dep_list=( "${dep_list[@]}" "$pkg_name" )
 143                         for dep_pkg in $(_grabfield "$pkg_dir/depends" %DEPENDS%); do
 144                                 spaces=$2               #Bash scoping ;_;
 145                                 if [ $graphviz -eq 1 ]; then
 146                                         echo "\"$1\" -> \"${dep_pkg%%[<>=]*}\" [color=$arrow1_color];"
 147                                 fi
 148                                 _tree "${dep_pkg%%[<>=]*}" $((spaces+1))
 149                         done
 150                 fi
 151         done
 152 }
 153
 154
 155 # Main program: gets all of the money, pays none of the taxes
 156
 157 # Command line parameters parser
 158 if [ $# -eq 0 ]; then
 159         _usage
 160         exit 1
 161 fi
 162
 163 options=( "$@" )
 164 len_options=${#options[@]}
 165 for (( n=0 ; n < $len_options ; n++ )); do
 166         if [ "${options[$n]}" = "--" ]; then
 167                 unset options[$n]
 168                 break
 169         fi
 170         if [ "${options[$n]}" = "-h" -o "${options[$n]}" = "--help" ]; then
 171                 _usage
 172                 exit 0
 173         fi
 174
 175         if [ "${options[$n]}" = "-v" -o "${options[$n]}" = "--version" ]; then
 176                 _version
 177                 exit 0
 178         fi
 179
 180         if [ "${options[$n]}" = "-l" -o "${options[$n]}" = "--linear" ]; then
 181                 unset options[$n]
 182                 linear=1
 183                 continue
 184         fi
 185
 186         if [ "${options[$n]}" = "-s" -o "${options[$n]}" = "--silent" ]; then
 187                 unset options[$n]
 188                 silent=1
 189                 continue
 190         fi
 191
 192         if [ "${options[$n]}" = "-u" -o "${options[$n]}" = "--unique" ]; then
 193                 unset options[$n]
 194                 silent=1
 195                 nodup=1
 196                 continue
 197         fi
 198
 199         if [ "${options[$n]}" = "-g" -o "${options[$n]}" = "--graph" ]; then
 200                 unset options[$n]
 201                 graphviz=1
 202                 continue
 203         fi
 204
 205         if [ "${options[$n]}" = "-c" -o "${options[$n]}" = "--color" ]; then
 206                 unset options[$n]
 207                 colored=1
 208                 continue
 209         fi
 210
 211         if [[ "${options[$n]}" =~ -d[[:digit:]]+ || "${options[$n]}" == "--depth" ]]; then
 212                 if [[ "${options[$n]#-d}" =~ [[:digit:]]+ ]]; then
 213                         max_depth="${options[$n]#-d}"
 214                 elif [[ ${options[$((n+1))]} =~ [[:digit:]]+ ]]; then
 215                         max_depth="${options[$((n+1))]}"
 216                         unset options[$((n+1))]
 217                         ((++n))
 218                 fi
 219                 unset options[$n]
 220                 continue
 221         fi
 222 done
 223 # End of the dumb command line parser
 224
 225 # Env
 226 colored=${colored:-0}
 227 max_depth=${max_depth:--10}
 228 linear=${linear:-0}
 229 silent=${silent:-0}
 230 nodup=${nodup:-0}
 231 graphviz=${graphviz:-0}
 232
 233 if [ $colored -ne 1 ]; then
 234         unset branch1_color
 235         unset leaf_color
 236         unset leaf2_color
 237         unset branch2_color
 238 fi
 239
 240 if [ $linear -eq 1 ]; then
 241         unset separator
 242         unset branch_tip1
 243         unset branch_tip2
 244         unset provides
 245 fi
 246
 247 if [ $graphviz -eq 1 ]; then
 248         silent=1
 249         nodup=0
 250         if [ ! -f /usr/bin/dot ]; then
 251                 echo "ERROR: package graphviz is not installed"
 252                 echo "       Run pacman -S graphviz to install it"
 253                 exit 1
 254         fi
 255 fi
 256
 257 if [ ! -r /etc/pacman.conf ]; then
 258         echo "ERROR: unable to read /etc/pacman.conf"
 259         exit 1
 260 else
 261         eval $(awk '/DBPath/ {print $1$2$3}' /etc/pacman.conf)
 262 fi
 263
 264 pac_db="${DBPath:-/var/lib/pacman}/local"
 265
 266 if [ ! -d "$pac_db" ] ; then
 267         echo "ERROR: pacman database directory ${pac_db} not found"
 268         exit 1
 269 fi
 270 # Env End
 271
 272
 273 # Program starts
 274 _main(){
 275         for pkg_name in ${options[@]} ; do
 276                 [ $graphviz -eq 1 ] && echo -e "\"START\" -> \"$pkg_name\" ;"
 277                 _tree "$pkg_name" 0
 278                 if [ $nodup -eq 1 ]; then
 279                         for pkg_tree in ${dep_list[@]} ; do
 280                                 echo "$pkg_tree"
 281                         done
 282                 fi
 283         done
 284         if [ $silent -eq 0 ]; then
 285                 echo -ne '\033[0m' # return colors to normal?
 286                 echo -ne '\033[?25h' #return cursor to normal?
 287         fi
 288 }
 289
 290
 291 if [ $graphviz -eq 1 ]; then
 292         root_pkgs="${options[@]}"
 293         # Uncomment for the "generated by pactree" node in graphviz
 294         #advert="xyz [height=0.07, fontsize=8.0, label=\"GENERATED WITH PACTREE\",shape=box,color="black",style=filled,fontcolor="white"];\n"
 295
 296         echo -e "digraph G { START [color=$start_color, style=filled];\n node [style=filled, color=$nodes_color];\n$(_main)\n$advert}" | dot -T$gformat -o "${root_pkgs// /_}.deps.$gformat"
 297 else _main
 298 fi
 299
 300 # vim: set ts=2 sw=2 noet: