correct help text for the 'both' option
[grml-hwinfo.git] / grml-hwinfo
index 3fed78d..7944a08 100755 (executable)
@@ -4,7 +4,6 @@
 # Authors:       grml-team (grml.org), (c) Michael Prokop <mika@grml.org>
 # Bug-Reports:   see http://grml.org/bugs/
 # License:       This file is licensed under the GPL v2.
-# Latest change: Don Aug 10 00:17:56 CEST 2006 [mika]
 ################################################################################
 # Notice: Some ideas have been taken from
 # http://club.black.co.at/david/hwdb/infodump
 ################################################################################
 
 # variables
-UNAME=$(uname -r)
-PN=$(basename $0)
-VERSION='0.2'
-if [[ -z "$INFOFILE" ]]; then
-  INFOFILE='info.tar.bz2'
+UNAME="$(uname -r)"
+PN="$(basename $0)"
+[ -n "$WORKING_DIR" -a -d "$WORKING_DIR" ] || WORKING_DIR=$(pwd)
+VERSION='0.4.1'
+TIMESTAMP='+%F--%H-%M-%S-%Z'
+TIMESTAMP_NANO='+%F--%H-%M-%S-%N-%Z'
+
+GENERATE_FILE='1'
+GENERATE_DIRECTORY=''
+
+while getopts "hdf" args; do
+  case "$args" in
+  h) echo "$PN - collect hardware information
+
+This tool collects information of the hardware this tool is being executed
+on.  It can be executed as normal user to collect some basic information or
+with root permissions to collect as much information as possible.  By
+default, a file named grml-hwinfo-TIMESTAMP.tar.bz2 storing all collected
+information will be created in the current working directory. Alternatively,
+you can have it create a directory with all information.
+
+Options:
+
+-h  :  Display this help
+-f  :  Create grml-hwinfo-TIMESTAMP.tar.bz2
+-d  :  Create grml-hwinfo-TIMESTAMP/
+
+-df :  Create both, the directory and the file
+"
+
+  exit 0;;
+
+  d)
+  GENERATE_FILE=''
+  GENERATE_DIRECTORY='1'
+  ;;
+
+  f) # generating file; default behaviour
+  GENERATE_FILE='1'
+  ;;
+
+  esac
+  done
+
+
+TMPDIR=$(mktemp -d) || { echo "Error creating a temporary directory, can not continue. Exiting.">&2 ; exit 1; }
+INFODIR="info"
+
+bailout() {
+  [ -d "$TMPDIR" ] && rm -rf "$TMPDIR"
+  [ -n "$1" ] && exit 1 || exit 0
+}
+
+DATE="$(date $TIMESTAMP)"
+[ -n "$INFOFILE" ] || INFOFILE="grml-hwinfo-$DATE.tar.bz2"
+INFOFILE="${WORKING_DIR}/${INFOFILE}"
+[ -n "$INFOOUTDIR" ] || INFOOUTDIR="grml-hwinfo-$DATE"
+INFOOUTDIR="${WORKING_DIR}/${INFOOUTDIR}"
+
+if [ "$(id -u)" != "0" ] ; then
+   NOTROOT=1
+   echo "Notice: you are running $PN without root permissions. Not all information will be collected."
+   echo
 fi
 
+# check whether a binary is available and executable
+exectest() {
+if [ -z "$1" ] ; then
+   echo 'Usage: exectest <binary>'>&2
+   return 1
+else
+   test -e "$(which $1)" && return 0 || return 1
+fi
+}
+
 # echo a list of all disks and their size
 # taken from http://cvs.debian.org/fai/lib/disk-info
-function diskandsize() {
+diskandsize() {
     local isdisk major minor blocks device suffix
     while read major minor blocks device suffix; do
         isdisk=1
         # skip ide cdrom
         [ -f /proc/ide/$device/media ] && grep -q cdrom /proc/ide/$device/media && isdisk=0
-        [ $isdisk -eq 1 ] && echo "$device $blocks"
+        [ "$isdisk" -eq 1 ] && echo "$device $blocks"
     done
 }
 
-function list_disks() {
+list_disks() {
 # print only every second entry; used by disk_info
 i=0
 for ent in $@; do
-    if [ $i -eq 0 ]; then
+    if [ "$i" -eq 0 ]; then
         echo $ent
         i=1
     else
@@ -44,34 +111,32 @@ for ent in $@; do
 done
 }
 
-function disk_info() {
+disk_info() {
     # the variable holds a space separated list of devices and their block size
     device_size=`grep -E ' cciss/c.d.$| ida/c.d.$| rd/c.d.$| hd.$| sd.$|/disc$' /proc/partitions | diskandsize`
-# grep -E ' cciss/c.d.\b| ida/c.d.\b| rd/c.d.\b| hd.\b| sd.\b|/disc\b' /proc/partitions | diskandsize
-
     # a list of all local disks, without size
     disklist=`list_disks $device_size`
 }
 
 echo "Running grml-hwinfo ${VERSION} - collecting hardware information."
-echo "Please send feedback, bugreports, feature requests to Michael Prokop <mika@grml.org>."
-echo ""
 
-mkdir info || exit -1
+mkdir "${TMPDIR}/${INFODIR}"
+cd "${TMPDIR}/${INFODIR}" || bailout 1
 (
-  cd info
+  cd "${TMPDIR}/${INFODIR}"
 
-  echo "Generating hardware information report using file $INFOFILE."
+  [ -n "$GENERATE_FILE" ]      && echo "Output file:      $INFOFILE"
+  [ -n "$GENERATE_DIRECTORY" ] && echo "Output directory: $INFOOUTDIR"
   echo "This might take a few seconds/minutes. Please be patient..."
 
 # some sysinfo
   date > date
   if [ -r /etc/grml_version ] ; then
-    cat /etc/grml_version > grml_version
-  else
-    echo "This does not seem to be a grml system. Continuing anyway..."
+     cat /etc/grml_version > grml_version
+  fi
+  if [ -r /etc/debian_version ] ; then
+     cat /etc/debian_version > debian_version
   fi
-  cat /etc/debian_version > debian_version
   uname -a > uname
 
 # disks / devices
@@ -80,10 +145,10 @@ mkdir info || exit -1
   [ -r /proc/bus/pnp ] && lspnp > lspnp
   [ -r /proc/bus/usb ] && lsusb > lsusb
   cat /proc/partitions > partitions
-  [ -r /proc/ide/ide?/hd?/geometry ] && grep . /proc/ide/ide?/hd?/geometry /dev/null | sed -e 's#/proc/ide/ide./##' > proc_ide
+  find /proc/ide/ -name geometry -exec grep . {} \; > proc_ide 2>/dev/null
   df -h > df 2>/dev/null
   for i in free lsmod mount lsdev ; do
-    [[ -x `which $i` ]] && $i > $i
+      exectest $i  && $i > $i
   done
 
 # proc stuff
@@ -91,51 +156,54 @@ mkdir info || exit -1
     mdstat meminfo modules mtrr pci version ; do
     [ -r /proc/$i ] && cat /proc/$i > proc_$i
   done
-  [[ -x `which sysdump` ]] && sysdump > sysdump 2>sysdump.error
+  exectest sysdump  && sysdump > sysdump 2>sysdump.error
 # for sysnet in `find /proc/sys/net/*/ -type f | grep -v flush`; do cat $sysnet >> sysnet ; done
 
 # log
   dmesg > dmesg.cur
 
 # hwinfo
-  [[ -x `which discover` ]] && discover -v --type-summary --enable-bus all > discover 2> discover.2
-  [[ -x `which hwinfo` ]] && hwinfo log=hwinfo
+  exectest discover && discover -v --type-summary --enable-bus all > discover 2> discover.2
+  exectest hwinfo   && hwinfo log=hwinfo
+  exectest x86info  && x86info > x86info 2>x86info.2
 
 # net stuff
-  [[ -x `which ifconfig` ]] && ifconfig -v -a  > ifconfig
-  [[ -x `which ip` ]] && ip route show   > ip_route
-  [[ -x `which ip` ]] && ip link show    > ip_link
-  [[ -x `which route` ]] && route -n        > route
+  exectest ifconfig  && ifconfig -v -a  > ifconfig
+  exectest ip        && ip route show   > ip_route
+  exectest ip        && ip link show    > ip_link
+  exectest route     && route -n        > route
 
 # software
-  dpkg --get-selections   > dpkg_get_selections
-  COLUMNS=300 dpkg --list > dpkg_list
-  COLUMNS=1000 dpkg -l linux-image-$UNAME | grep linux-image-$UNAME | tr -s ' ' > running_kernel
+  if exectest dpkg ; then
+     dpkg --get-selections   > dpkg_get_selections
+     COLUMNS=300 dpkg --list > dpkg_list
+     COLUMNS=1000 dpkg -l linux-image-$UNAME | grep linux-image-$UNAME | tr -s ' ' > running_kernel
+  fi
 
-# powermanagement
-  [[ -x `which laptop-detect` ]] && laptop-detect 1>/dev/null 2>/dev/null && echo "0" > laptop_detected
-  [[ -x `which acpi_available` ]] && acpi_available && cat /proc/acpi/info > acpi_info
-  [[ -x `which acpi` ]] && acpi > acpi 2> acpi.error && acpi -v > acpi.version
-  [ -r /proc/apm/  ]  && apm > acpi
+# power management
+  exectest laptop-detect  && laptop-detect >/dev/null 2>/dev/null && echo "0" > laptop_detected
+  exectest acpi_available && acpi_available && cat /proc/acpi/info > acpi_info
+  exectest acpi && acpi > acpi 2> acpi.error && acpi -v > acpi.version
+  [ -r /proc/apm/ ] && apm > apm
 
 # kernel stuff
   if [ -r /proc/config.gz ] ; then
-    zcat /proc/config.gz > kernelconfig
+     zcat /proc/config.gz > kernelconfig
   else
-    [ -r /boot/config-$UNAME ] && cat /boot/config-$UNAME > kernelconfig
+     [ -r /boot/config-$UNAME ] && cat /boot/config-$UNAME > kernelconfig
   fi
 
 # X stuff
   if [ -n "${DISPLAY}" ] ; then
-    [[ -x `which xviddetect` ]] && xviddetect         > xviddetect
-    [[ -x `which xvidtune`   ]] && xvidtune -show     > xdivtune
-    [[ -x `which xrandr`     ]] && xrandr             > xrandr
-    [[ -x `which xdpyinfo`   ]] && xdpyinfo           > xdpyinfo
-    X -version        1> x_version 2>&1
+     exectest xviddetect  && xviddetect         > xviddetect
+     exectest xvidtune    && xvidtune -show     > xdivtune
+     exectest xrandr      && xrandr             > xrandr
+     exectest xdpyinfo    && xdpyinfo           > xdpyinfo
+     X -version > x_version 2>&1
   fi
 
   for i in Xorg.0.log Xorg.7.log Xorg.8.log XFree86.0.log XFree86.7.log XFree86.8.log dmesg ; do
-    cp /var/log/$i log_$i 2>/dev/null
+      cp /var/log/$i log_$i 2>/dev/null
   done
 
   cp /etc/X11/xorg.conf    xorg.conf    2>/dev/null
@@ -146,52 +214,69 @@ mkdir info || exit -1
 # sysinfo -class device -level all
 
 # as root:
-if [ $UID != 0 ] ; then
-  echo "not running as root" > root
-  NOTROOT="yes"
+if [ -n "$NOTROOT" ] ; then
+   echo "not running as root" > root
 else
-  echo "running as root" > root
-  disk_info
-  [[ -x `which sfdisk`    ]] && sfdisk -d > sfdisk 2>sfdisk.error
-  [[ -x `which ddcprobe`  ]] && ddcprobe  > ddcprobe
-  [[ -x `which dmidecode` ]] && dmidecode > dmidecode
-  for disk in $disklist; do
-     [[ -x `which smartctl` ]] && smartctl -i /dev/$disk >> smartctl
-     [[ -x `which hdparm`   ]] && hdparm -iv /dev/$disk  >> hdparm
-     [[ -x `which fdisk`    ]] && fdisk -lu /dev/$disk   >> fdisk 2>>fdisk.error
-     [[ -x `which parted`   ]] && parted -s /dev/$disk print >> parted
-     LC_ALL=C file -s /dev/$disk?* | grep -v ": empty" >> file_disk
-  done
+   echo "running as root" > root
+   disk_info
+   exectest sfdisk     && sfdisk -d > sfdisk 2>sfdisk.error
+   exectest ddcprobe   && ddcprobe  > ddcprobe
+   exectest dmidecode  && dmidecode > dmidecode
+
+   exectest dconf && dconf -o dconf
+
+   if [ -x /usr/share/doc/lm-sensors/examples/eeprom/decode-dimms.pl ] ; then
+      /usr/share/doc/lm-sensors/examples/eeprom/decode-dimms.pl > decode-dimms 2>decode-dimms.error
+   fi
+
+   for disk in $disklist; do
+      exectest smartctl  && echo "smartctl -a /dev/$disk :\n" >> smartctl && smartctl -a /dev/$disk       >> smartctl             && echo "\n\n" >> smartctl
+      exectest hdparm    && echo "hdparm -iv  /dev/$disk :\n" >> hdparm   && hdparm -iv  /dev/$disk       >> hdparm               && echo "\n\n" >> hdparm
+      exectest fdisk     && echo "fdisk -lu   /dev/$disk :\n" >> fdisk    && fdisk -lu   /dev/$disk       >> fdisk 2>>fdisk.error && echo "\n\n" >> fdisk
+      exectest parted    && echo "parted -s   /dev/$disk :\n" >> parted   && parted -s   /dev/$disk print >> parted               && echo "\n\n" >> parted
+      LC_ALL=C file -s /dev/$disk?* | grep -v ": empty" >> file_disk
+   done
 fi
 )
 
-tar jcf $INFOFILE info/ && rm -Rf info/
-
-echo ""
-[ -n "$NOTROOT" ]  && echo "Notice: you are running $PN without root permissions! Not all information could be collected!"
-echo ""
-[ -r "$INFOFILE" ] && echo "$INFOFILE ($(ls -ahl $INFOFILE | awk '{print $5}')) has been generated."
-echo ""
-
-#echo ""
-#echo 'Thanks for collecting this information!'
-#echo ""
-#echo "Please fill out this form and send it together with $INFOFILE ($(ls -ahl $INFOFILE | awk '{print $5}')) to"
-#echo "  Michael Prokop <mika@grml.org>"
-#echo ""
-#
-#cat <<EOF
-#Class: <Laptop/Desktop/Server/built-to-order/self-assembled>
-#Manufacturer:
-#Model:
-#Distributor: <Where did you buy it>
-#Bought in: <Country and Date>
-#
-#Components/Options: <If the PC was built-to-order or self assembled, please
-#        list the options or components you used>
-#
-#Additional Notes:
-#
-#EOF
+if [ -n "$GENERATE_DIRECTORY" ] ; then
+  if [ -e "${INFOOUTDIR}" ] ; then
+     # falling back onto nanoseconds as tie-breaker
+     DATE="$(date $TIMESTAMP_NANO)"
+     NEW_INFOOUTDIR="${WORKING_DIR}/grml-hwinfo-$DATE"
+     echo
+     echo "Warning: $INFOOUTDIR exists already, using $NEW_INFOOUTDIR instead.">&2
+     INFOOUTDIR="$NEW_INFOOUTDIR" # adjust variable for final info message
+  fi
+
+  cd "${TMPDIR}"
+  cp -ax "${TMPDIR}/info" "${INFOOUTDIR}"
+
+  echo
+  [ -r "$INFOOUTDIR" ] && echo "$INFOOUTDIR has been generated."
+  echo
+fi
+
+if [ -n "$GENERATE_FILE" ] ; then
+  # finally create the tarball
+  if [ -e "${INFOFILE}" ] ; then
+     # falling back onto nanoseconds as tie-breaker
+     DATE="$(date $TIMESTAMP_NANO)"
+     NEW_INFOFILE="${WORKING_DIR}/grml-hwinfo-$DATE.tar.bz2"
+     echo
+     echo "Warning: $INFOFILE exists already, using $NEW_INFOFILE instead.">&2
+     INFOFILE="$NEW_INFOFILE" # adjust variable for final info message
+  fi
+
+  cd "${TMPDIR}"
+  tar jcf "${INFOFILE}" "${INFODIR}"
+  cd "${WORKING_DIR}"
+
+  echo
+  [ -r "$INFOFILE" ] && echo "$INFOFILE ("$(ls -ahl "$INFOFILE" | awk '{print $5}')") has been generated."
+  echo
+fi
+
+bailout
 
 ## END OF FILE##################################################################