Merge branch 'master' into __jail

conf/explorer/lsb_codename

@@ -20,7 +20,14 @@
 #
 
 set +e
-lsb_release=$(which lsb_release 2>/dev/null)
+case "$($__explorer/os)" in
-if [ -x "$lsb_release" ]; then
+   openwrt)
+      (. /etc/openwrt_release && echo "$DISTRIB_CODENAME")
+   ;;
+   *)
+      lsb_release=$(which lsb_release 2>/dev/null)
+      if [ -x "$lsb_release" ]; then
          $lsb_release --short --codename
-fi
+      fi
+   ;;
+esac

conf/explorer/lsb_description

@@ -20,7 +20,14 @@
 #
 
 set +e
-lsb_release=$(which lsb_release 2>/dev/null)
+case "$($__explorer/os)" in
-if [ -x "$lsb_release" ]; then
+   openwrt)
+      (. /etc/openwrt_release && echo "$DISTRIB_DESCRIPTION")
+   ;;
+   *)
+      lsb_release=$(which lsb_release 2>/dev/null)
+      if [ -x "$lsb_release" ]; then
          $lsb_release --short --description
-fi
+      fi
+   ;;
+esac

conf/explorer/lsb_id

@@ -20,7 +20,14 @@
 #
 
 set +e
-lsb_release=$(which lsb_release 2>/dev/null)
+case "$($__explorer/os)" in
-if [ -x "$lsb_release" ]; then
+   openwrt)
+      (. /etc/openwrt_release && echo "$DISTRIB_ID")
+   ;;
+   *)
+      lsb_release=$(which lsb_release 2>/dev/null)
+      if [ -x "$lsb_release" ]; then
          $lsb_release --short --id
-fi
+      fi
+   ;;
+esac

conf/explorer/lsb_release

@@ -20,7 +20,14 @@
 #
 
 set +e
-lsb_release=$(which lsb_release 2>/dev/null)
+case "$($__explorer/os)" in
-if [ -x "$lsb_release" ]; then
+   openwrt)
+      (. /etc/openwrt_release && echo "$DISTRIB_RELEASE")
+   ;;
+   *)
+      lsb_release=$(which lsb_release 2>/dev/null)
+      if [ -x "$lsb_release" ]; then
          $lsb_release --short --release
-fi
+      fi
+   ;;
+esac

conf/explorer/os

@@ -56,6 +56,11 @@ if [ -f /etc/gentoo-release ]; then
    exit 0
 fi
 
+if [ -f /etc/openwrt_version ]; then
+    echo openwrt
+    exit 0
+fi
+
 if [ -f /etc/owl-release ]; then
    echo owl
    exit 0

conf/explorer/os_version

@@ -45,6 +45,9 @@ case "$($__explorer/os)" in
    *bsd|solaris)
       uname -r
    ;;
+   openwrt)
+      cat /etc/openwrt_version
+   ;;
    owl)
       cat /etc/owl-release
    ;;

conf/type/__package/manifest

@@ -30,10 +30,12 @@ else
    # By default determine package manager based on operating system
    os="$(cat "$__global/explorer/os")"
    case "$os" in
+         amazon|centos|fedora|redhat) type="yum" ;;
          archlinux) type="pacman" ;;
          debian|ubuntu) type="apt" ;;
+         freebsd) type="pkg_freebsd" ;;
          gentoo) type="emerge" ;;
-         amazon|centos|fedora|redhat) type="yum" ;;
+         openwrt) type="opkg" ;;
          *)
             echo "Don't know how to manage packages on: $os" >&2
             exit 1

conf/type/__package/parameter/optional

@@ -1,3 +1,4 @@
 name
 version
 type
+pkgsite

conf/type/__package_opkg/explorer/pkg_status

@@ -0,0 +1,39 @@
+#!/bin/sh
+#
+# 2011 Nico Schottelius (nico-cdist at schottelius.org)
+# 2012 Giel van Schijndel (giel plus cdist at mortis dot eu)
+#
+# This file is part of cdist.
+#
+# cdist is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# cdist is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with cdist. If not, see <http://www.gnu.org/licenses/>.
+#
+#
+# Retrieve the status of a package - parsed opkg output
+#
+
+if [ -f "$__object/parameter/name" ]; then
+   name="$(cat "$__object/parameter/name")"
+else
+   name="$__object_id"
+fi
+
+# Except dpkg failing, if package is not known / installed
+if opkg status "$name" 2>/dev/null | grep -q "^Status: install user installed$"; then
+   echo "present"
+   exit 0
+elif [ "$(opkg info "$name" 2> /dev/null | wc -l)" -eq 0 ]; then
+   echo "absent notpresent"
+   exit 0
+fi
+echo "absent"

conf/type/__package_opkg/gencode-remote

@@ -0,0 +1,57 @@
+#!/bin/sh
+#
+# 2011 Nico Schottelius (nico-cdist at schottelius.org)
+# 2012 Giel van Schijndel (giel plus cdist at mortis dot eu)
+#
+# This file is part of cdist.
+#
+# cdist is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# cdist is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with cdist. If not, see <http://www.gnu.org/licenses/>.
+#
+#
+# Manage packages on OpenWRT and co.
+#
+
+if [ -f "$__object/parameter/name" ]; then
+   name="$(cat "$__object/parameter/name")"
+else
+   name="$__object_id"
+fi
+
+state_should="$(cat "$__object/parameter/state")"
+state_is="$(cat "$__object/explorer/pkg_status")"
+case "$state_is" in
+    absent*)
+       present="$(echo "$state_is" | cut -d ' ' -f 2)"
+       state_is="absent"
+    ;;
+esac
+
+if [ "$state_is" != "$state_should" ]; then
+   case "$state_should" in
+      present)
+         if [ "$present" = "notpresent" ]; then
+            echo opkg --verbosity=0 update
+         fi
+         echo opkg --verbosity=0 install \"$name\"
+      ;;
+      absent)
+         echo opkg --verbosity=0 remove \"$name\"
+      ;;
+      *)
+         echo "Unknown state: $state" >&2
+         exit 1
+      ;;
+   esac
+fi
+

conf/type/__package_opkg/man.text

@@ -0,0 +1,49 @@
+cdist-type__package_opkg(7)
+==========================
+Giel van Schijndel <giel+cdist--@--mortis.eu>
+
+
+NAME
+----
+cdist-type__package_opkg - Manage packages with opkg
+
+
+DESCRIPTION
+-----------
+opkg is usually used on OpenWRT to manage packages.
+
+
+REQUIRED PARAMETERS
+-------------------
+state::
+   The state the package should be in, either "present" or "absent"
+
+
+OPTIONAL PARAMETERS
+-------------------
+name::
+   If supplied, use the name and not the object id as the package name.
+
+
+EXAMPLES
+--------
+
+--------------------------------------------------------------------------------
+# Ensure lsof is installed
+__package_opkg lsof --state present
+
+# Remove obsolete package
+__package_opkg dnsmasq --state absent
+--------------------------------------------------------------------------------
+
+
+SEE ALSO
+--------
+- cdist-type(7)
+- cdist-type__package(7)
+
+
+COPYING
+-------
+Copyright \(C) 2012 Giel van Schijndel. Free use of this software is
+granted under the terms of the GNU General Public License version 3 (GPLv3).

conf/type/__package_opkg/parameter/optional

@@ -0,0 +1 @@
+name

conf/type/__package_opkg/parameter/required

@@ -0,0 +1 @@
+state

conf/type/__package_pkg_freebsd/explorer/pkg_version

@@ -0,0 +1,35 @@
+#!/bin/sh
+#
+# 2012 Jake Guffey (jake.guffey at eprotex.com)
+#
+# This file is part of cdist.
+#
+# cdist is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# cdist is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with cdist. If not, see <http://www.gnu.org/licenses/>.
+#
+#
+# Retrieve the status of a package - parsed dpkg output
+#
+
+if [ -f "$__object/parameter/name" ]; then
+   name="$(cat "$__object/parameter/name")"
+else
+   name="$__object_id"
+fi
+
+# Don't produce "no pkgs installed" output -- breaks things
+PKG_OUTPUT=$(pkg_info 2>&1)
+if [ ! "$PKG_OUTPUT" = "pkg_info: no packages installed" ]; then
+	echo "$(echo "$PKG_OUTPUT" | grep "^$name-" | cut '-d ' -f1 | sed "s/$name-//g")"
+fi
+

conf/type/__package_pkg_freebsd/gencode-remote

@@ -0,0 +1,136 @@
+#!/bin/sh
+#
+# 2012 Jake Guffey (jake.guffey at eprotex.com)
+#
+# This file is part of cdist.
+#
+# cdist is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# cdist is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with cdist. If not, see <http://www.gnu.org/licenses/>.
+#
+#
+# Manage packages with pkg on FreeBSD
+#
+
+assert ()                 #  If condition false,
+{                         #+ exit from script with error message.
+	E_PARAM_ERR=98
+	E_ASSERT_FAILED=99
+
+	if [ -z "$2" ]          # Not enough parameters passed.
+	then
+		return $E_PARAM_ERR   # No damage done.
+	fi
+
+	lineno=$2
+
+	if [ ! $1 ] 
+	then
+		echo "Assertion failed:  \"$1\""
+		echo "File \"$0\", line $lineno, called by $(caller 0)"
+		exit $E_ASSERT_FAILED
+	fi  
+}
+
+# Debug
+#exec >&2
+#set -x
+
+if [ -f "$__object/parameter/name" ]; then
+	name="$(cat "$__object/parameter/name")"
+else
+	name="$__object_id"
+fi
+
+if [ -f "$__object/parameter/flavor" ]; then
+	flavor="$(cat "$__object/parameter/flavor")"
+fi
+
+if [ -f "$__object/parameter/version" ]; then
+	version="$(cat "$__object/parameter/version")"
+fi
+
+if [ -f "$__object/parameter/pkgsite" ]; then
+	pkgsite="$(cat "$__object/parameter/pkgsite")"
+fi
+
+state="$(cat "$__object/parameter/state")"
+curr_version="$(cat "$__object/explorer/pkg_version")"
+add_cmd="pkg_add"
+rm_cmd="pkg_delete"
+cmd=""
+
+# Print the command to be executed
+#	Parms:	$1 -- mode, "remove" or "add"
+#		$2 -- the command to be echoed
+# FIXME: This is ugly.
+execcmd(){
+	# Set the PACKAGESITE if we're ADDing a new package
+	if [ "$1" = "add" -a -n "$pkgsite" ]; then
+		# Use http.../All/ if we know the exact version we want, use .../Latest/ otherwise
+		pkgsite="export PACKAGESITE=${pkgsite}"
+		[ -n "$version" ] && pkgsite="${pkgsite}/All/" || pkgsite="${pkgsite}/Latest/"
+		echo "${pkgsite}"
+	fi
+	echo "${2} 2>&- >&-"	# Silence the output of the command
+	echo "status=\$?"
+	echo "if [ \"\$status\" -ne \"0\" ]; then"
+	echo "	echo \"Error: ${cmd} exited nonzero with \$status\"'!' >&2"
+	echo "	exit 1"
+	echo "fi"
+}
+
+if [ -n "$curr_version" ]; then	# PKG *is* installed
+	if [ "$state" = "absent" ]; then	# Shouldn't be installed
+		if [ -n "$flavor" ]; then
+			cmd="${rm_cmd} ${name}-${flavor}-${curr_version}"
+		else
+			cmd="${rm_cmd} ${name}-${curr_version}"
+		fi
+		execcmd "remove" "${cmd}"
+		exit 0
+	else	# Should be installed
+		if [ -n "$version" ]; then	# Want a specific version
+			if [ "$version" = "$curr_version" ]; then	# Current version is correct
+				exit 0
+			else	# Current version is wrong, fix
+				#updatepkg "$name" "$version"
+				assert "! ${version} = ${curr_version}" $LINENO
+				cmd="${rm_cmd} ${name}-${curr_version}"
+				execcmd "remove" "${cmd}"
+				cmd="${add_cmd} ${name}-${version}"
+				execcmd "add" "${cmd}"
+			fi
+		else	# Don't care what version to use
+			exit 0
+		fi
+	fi
+else	# PKG *isn't* installed
+	if [ "$state" = "absent" ]; then	# Shouldn't be installed
+		exit 0
+	elif [ "$state" = "present" ]; then	# Is not currently installed, should be
+		if [ -n "$flavor" ]; then
+			cmd="${add_cmd} -r ${name}-${flavor}"
+		else
+			cmd="${add_cmd} -r ${name}"
+		fi
+		if [ -n "$version" ]; then
+			cmd="${cmd}-${version}"
+		fi
+		execcmd "add" "${cmd}"
+		exit 0
+	fi
+fi
+
+# Debug
+#set +x
+

conf/type/__package_pkg_freebsd/man.text

@@ -0,0 +1,64 @@
+cdist-type__package_pkg_freebsd(7)
+==================================
+Jake Guffey <jake.guffey--@--eprotex.com>
+
+
+NAME
+----
+cdist-type__package_pkg_freebsd - Manage FreeBSD packages 
+
+
+DESCRIPTION
+-----------
+This type is usually used on FreeBSD to manage packages.
+
+
+REQUIRED PARAMETERS
+-------------------
+state::
+   Either "present" or "absent".
+
+
+OPTIONAL PARAMETERS
+-------------------
+name::
+   If supplied, use the name and not the object id as the package name.
+
+flavor::
+   If supplied, use to avoid ambiguity.
+
+version::
+   If supplied, use to install a specific version of the package named.
+
+pkgsite::
+   If supplied, use to install from a specific package repository.
+
+
+EXAMPLES
+--------
+
+--------------------------------------------------------------------------------
+# Ensure zsh is installed
+__package_pkg_freebsd zsh --state installed
+
+# Ensure vim is installed, use flavor no_x11
+__package_pkg_freebsd vim --state installed --flavor no_x11
+
+# If you don't want to follow pythonX packages, but always use python
+__package_pkg_freebsd python --state installed --name python2
+
+# Remove obsolete package
+__package_pkg_freebsd puppet --state removed
+--------------------------------------------------------------------------------
+
+
+SEE ALSO
+--------
+- cdist-type(7)
+- cdist-type__package(7)
+
+
+COPYING
+-------
+Copyright \(C) 2012 Jake Guffey. Free use of this software is
+granted under the terms of the GNU General Public License version 3 (GPLv3).

conf/type/__package_pkg_freebsd/parameter/optional

@@ -0,0 +1,4 @@
+name
+flavor
+version
+pkgsite

conf/type/__package_pkg_freebsd/parameter/required

@@ -0,0 +1 @@
+state

doc/changelog

@@ -4,6 +4,13 @@ Changelog
 	* Changes are always commented with their author in (braces)
 	* Exception: No braces means author == Nico Schottelius
 
+2.0.9:
+	* Cleanup documentation: Fix environment variable list to be properly 
+		displayed (Giel van Schijndel)
+	* New Type: __package_opkg (Giel van Schijndel)
+	* New Type: __package_pkg_freebsd (Jake Guffey)
+	* Feature __package: Support OpenWRT (Giel van Schijndel)
+
 2.0.8: 2012-02-20
 	* Bugfix core: Remove another nasty traceback when sending SIGINT (aka Ctrl-C)
 	* Cleanup: Better hint to source of error

doc/man/cdist-reference.text.sh

@@ -188,6 +188,7 @@ __object_id::
     the filesystem database and ensured by the core).
 
     Note: Double slashes ("//") will not be fixed and result in an error.
+
 __self::
     DEPRECATED: Same as __object_name, do not use anymore, use __object_name instead.
     Will be removed in cdist 3.x.