[gentoo-commits] eselect r503 - in trunk: . libs man modules

[Ulrich Mueller (ulm)]

Author: ulm
Date: 2009-04-25 13:59:35 +0000 (Sat, 25 Apr 2009)
New Revision: 503

Added:
   trunk/man/news-tng.eselect.5
   trunk/modules/news-tng.eselect
Modified:
   trunk/ChangeLog
   trunk/libs/package-manager.bash.in
   trunk/man/Makefile.am
   trunk/modules/Makefile.am
Log:
Yet another module for reading GLEP 42 news items. Rewritten from scratch.
New function "get_repo_news_dir" in package-manager.bash.


Modified: trunk/ChangeLog
===================================================================
--- trunk/ChangeLog	2009-04-25 13:03:44 UTC (rev 502)
+++ trunk/ChangeLog	2009-04-25 13:59:35 UTC (rev 503)
@@ -1,5 +1,14 @@
 2009-04-25  Ulrich Mueller  <ulm@g.o>
 
+	* modules/news-tng.eselect: Yet another module for reading GLEP 42
+	news items. Rewritten from scratch.
+	* man/news-tng.eselect.5: New man page.
+	* modules/Makefile.am (safe_scripts):
+	* man/Makefile.am (man_MANS): Update.
+
+	* libs/package-manager.bash.in (get_repo_news_dir): New function.
+	(get_news_dir_name): Call get_repo_news_dir.
+
 	* libs/Makefile.am (dosed): Remove Paludis substitution, it is
 	unused since the change of 2008-01-28.
 

Modified: trunk/libs/package-manager.bash.in
===================================================================
--- trunk/libs/package-manager.bash.in	2009-04-25 13:03:44 UTC (rev 502)
+++ trunk/libs/package-manager.bash.in	2009-04-25 13:59:35 UTC (rev 503)
@@ -40,7 +40,7 @@
             sparc*) ret=sparc ;;
             x86_64) ret=amd64 ;;
             *) write_warning_msg \
-                "Unknown architecture. Please submit a bug including the output of 'uname -m'!"
+                "Unknown architecture. Please submit a bug including the output of 'uname -m'"
                 return 1
                 ;;
             esac
@@ -52,7 +52,7 @@
                 OpenBSD) suffix="-obsd" ;;
                 DragonFly) suffix="-dfly" ;;
                 *) write_warning_msg \
-                    "Unknown OS. Please submit a bug including the output of 'uname -s'!"
+                    "Unknown OS. Please submit a bug including the output of 'uname -s'"
                     return 1
                     ;;
             esac
@@ -64,7 +64,7 @@
 # best-version
 # Return true if package $2 is available in ${ROOT}
 best-version() {
-    [[ $# -eq 1 ]] || die "has_version expects exactly 1 arguments!"
+    [[ $# -eq 1 ]] || die "has_version expects exactly one argument"
 
     local manager=$(package-manager)
     case ${manager} in
@@ -75,7 +75,7 @@
             portageq has_version "${ROOT}" "${1}" 2>/dev/null
             ;;
         *)
-            die "Unknown package manager: \"${manager}\"!"
+            die "Unknown package manager: \"${manager}\""
     esac
 }
 
@@ -83,7 +83,7 @@
 # Return the contents of environment variable $2 as seen by package manager(s)
 # for package $1.
 envvar() {
-    [[ $# -eq 2 ]] || die "envvar expects exactly 2 arguments!"
+    [[ $# -eq 2 ]] || die "envvar expects exactly 2 arguments"
 
     local manager=$(package-manager)
     case ${manager} in
@@ -95,14 +95,14 @@
             portageq envvar "${2}" 2>/dev/null
             ;;
         *)
-            die "Unknown package manager: \"${manager}\"!"
+            die "Unknown package manager: \"${manager}\""
     esac
 }
 
 # has-version
 # Return true if package $2 is available in ${ROOT}
 has-version() {
-    [[ $# -eq 1 ]] || die "has_version expects exactly 1 arguments!"
+    [[ $# -eq 1 ]] || die "has_version expects exactly one argument"
 
     local manager=$(package-manager)
     case ${manager} in
@@ -115,7 +115,7 @@
             return $?
             ;;
         *)
-            die "Unknown package manager: \"${manager}\"!"
+            die "Unknown package manager: \"${manager}\""
     esac
 }
 
@@ -131,27 +131,34 @@
             done
             ;;
         *)
-            die "Unknown package manager: \"${manager}\"!"
+            die "Unknown package manager: \"${manager}\""
     esac
 }
 
-get_news_dir_name() {
-    [[ $# -eq 1 ]] || die "get_news_dir_name expects exactly 1 argument!"
-
-    local name=${1%::*} repo=${1##*::}
+# get_repo_news_dir
+# return the directory where to find GLEP 42 news items for repository $1
+get_repo_news_dir() {
+    [[ $# -eq 1 ]] || die "get_repo_news_dir expects exactly one argument"
+    local repo=$1
     local manager=$(package-manager)
     case ${manager} in
         paludis)
-            echo "$($(paludis_command) --configuration-variable ${repo} newsdir)/${name}"
+            $(paludis_command) --configuration-variable ${repo} newsdir
             ;;
         portage)
-            echo "$(portage_get_repository ${repo})/metadata/news/${name}"
+            echo "$(portage_get_repository ${repo})/metadata/news"
             ;;
         *)
-            die "Unknown package manager: \"${manager}\"!"
+            die "Unknown package manager: \"${manager}\""
     esac
 }
 
+get_news_dir_name() {
+    [[ $# -eq 1 ]] || die "get_news_dir_name expects exactly one argument"
+    local name=${1%::*} repo=${1##*::}
+    echo "$(get_repo_news_dir "${repo}")/${name}"
+}
+
 # package-manager PRIVATE
 # Return the package manager we're going to use.
 package-manager() {
@@ -172,6 +179,8 @@
     fi
 
     echo ${manager}
+    # caching doesn't really work: we are typically called with
+    # command substitution, i.e. in a subshell
     ESELECT_PACKAGE_MANAGER=${manager}
 }
 

Modified: trunk/man/Makefile.am
===================================================================
--- trunk/man/Makefile.am	2009-04-25 13:03:44 UTC (rev 502)
+++ trunk/man/Makefile.am	2009-04-25 13:59:35 UTC (rev 503)
@@ -5,6 +5,7 @@
 	   env.eselect.5 \
 	   kernel.eselect.5 \
 	   mailer.eselect.5 \
+	   news-tng.eselect.5 \
 	   pager.eselect.5 \
 	   profile.eselect.5 \
 	   rc.eselect.5 \

Added: trunk/man/news-tng.eselect.5
===================================================================
--- trunk/man/news-tng.eselect.5	                        (rev 0)
+++ trunk/man/news-tng.eselect.5	2009-04-25 13:59:35 UTC (rev 503)
@@ -0,0 +1,82 @@
+.\" Copyright 2009 Gentoo Foundation
+.\" Distributed under the terms of the GNU General Public License v2
+.\" $Id$
+.\"
+.TH news-tng.eselect 5 "April 2009" "Gentoo Linux" eselect
+.SH NAME
+news-tng.eselect \- Yet another GLEP 42 news module for Gentoo's eselect
+.SH SYNOPSIS
+.B eselect news-tng
+.RB [ help | usage | version ]
+.br
+.B eselect news-tng list
+.br
+.B eselect news-tng read
+.RI [ item ...]
+.br
+.B eselect news-tng unread
+.RI [ item ...]
+.br
+.B eselect news-tng purge
+.br
+.B eselect news-tng count
+.RB [ new | all ]
+.SH DESCRIPTION
+.B eselect
+is Gentoo's configuration and management tool.  It features modules
+that care for the individual administrative tasks.
+.SH ACTION: LIST
+.B eselect news-tng list
+.br
+List all Gentoo news items.
+
+# eselect news-tng list
+.br
+News items:
+.br
+  [1]   2009-04-18  (unread)  Generation 1 Java Setup Deprecated
+  [2]   2009-04-06  (read)    Migration from teTeX to TeXLive
+  [3]   2009-04-06  (read)    Migration to X.org Server 1.5
+.SH ACTION: READ
+.B eselect news-tng read
+.RI [ item ...]
+.br
+Read news item(s), selected by their
+.I item
+number(s) from the
+.B list
+action.  Special items
+.B new
+and
+.B all
+select all unread items or all items, respectively.
+.SH ACTION: UNREAD
+.B eselect news-tng unread
+.RI [ item ...]
+.br
+Mark news item(s) as unread again.  Items are selected by their
+.I item
+number(s) from the
+.B list
+action.  Special item
+.B all
+selects all items.
+.SH ACTION: PURGE
+.B eselect news-tng purge
+.br
+Purge all read news item(s).
+.SH ACTION: COUNT
+.B eselect news-tng count
+.RB [ new | all ]
+.br
+Display number of unread news items (default) or of all news items,
+if option
+.B all
+is given.
+.SH AUTHOR
+Ulrich Mueller <ulm@g.o>
+.SH SEE ALSO
+.BR eselect (1),
+http://www.gentoo.org/proj/en/glep/glep-0042.html
+.SH REVISION
+$Id$


Property changes on: trunk/man/news-tng.eselect.5
___________________________________________________________________
Name: svn:keywords
   + Id

Modified: trunk/modules/Makefile.am
===================================================================
--- trunk/modules/Makefile.am	2009-04-25 13:03:44 UTC (rev 502)
+++ trunk/modules/Makefile.am	2009-04-25 13:59:35 UTC (rev 503)
@@ -8,6 +8,7 @@
 		 kernel.eselect \
 		 mailer.eselect \
 		 modules.eselect \
+		 news-tng.eselect \
 		 pager.eselect \
 		 profile.eselect \
 		 rc.eselect \

Added: trunk/modules/news-tng.eselect
===================================================================
--- trunk/modules/news-tng.eselect	                        (rev 0)
+++ trunk/modules/news-tng.eselect	2009-04-25 13:59:35 UTC (rev 503)
@@ -0,0 +1,293 @@
+# Copyright 2005-2009 Gentoo Foundation
+# Distributed under the terms of the GNU General Public License v2
+# $Id$
+
+inherit package-manager
+
+DESCRIPTION="Read Gentoo (\"GLEP 42\") news items"
+MAINTAINER="ulm@g.o"
+SVN_DATE='$Date$'
+VERSION=$(svn_date_to_version "${SVN_DATE}")
+
+NEWS_DIR="/var/lib/gentoo/news"
+
+# read list of news items
+# list of parameters may contain "unread" or "read"
+# returns one item per line: status/repository/name
+# sort order: 1. "unread" before "read", 2. by repository
+find_items() {
+	local stat repo item
+	local -a repos=( $(get_repositories) )
+	for stat in "$@"; do
+		for repo in ${repos[@]}; do
+			file="${ROOT}${NEWS_DIR}/news-${repo}.${stat}"
+			[[ -f ${file} ]] || continue
+			for item in $(<"${file}"); do
+				echo "${stat}/${repo}/${item}"
+			done
+		done
+	done
+}
+
+# write list of items to file
+# first parameter is "unread" or "read"
+# second parameter is the repository
+# list of items is expected in global array "items"
+write_item_list() {
+	local stat=$1 repo=$2 item update
+	for item in ${items[@]}; do
+		[[ ${item%%/*} = ${stat} ]] || continue
+		item=${item#*/}
+		[[ ${item%%/*} = ${repo} ]] && update="${update} ${item#*/}"
+	done
+	file="${ROOT}${NEWS_DIR}/news-${repo}.${stat}"
+	if [[ ! -w ${file} ]]; then
+		write_error_msg \
+			"Cannot update list of news items for repository \"${repo}\""
+		return 1
+	fi
+	for item in ${update}; do
+		echo "${item}"
+	done >"${file}" || die "Error writing file ${file}"
+}
+
+# read a given item
+# first parameter is the directory
+# second parameter is the item's name
+# optional third parameter may be "header", "body", or "existsp"
+read_item() {
+	local dir=$1 item=$2 what=$3 file lang command=""
+	for lang in $(accepted_languages); do
+		file="${ROOT}${dir}/${item}/${item}.${lang}.txt"
+		[[ -f "${file}" ]] || continue
+		case "${what}" in
+			header) command="/^$/Q" ;;
+			body) command="0,/^$/d" ;;
+			existsp) return 0 ;;
+		esac
+		sed -e "${command}" "${file}" || die "Error reading ${file}"
+		return
+	done
+	return 1
+}
+
+# find directory for a given repository (and cache it)
+# affects variable "dir" and arrays "repos" and "dirs" by side effect
+find_repo_dir() {
+	local repo=$1 i
+	for (( i = 0; i < ${#repos[@]}; i++ )); do
+		[[ ${repos[i]} = ${repo} ]] && break
+	done
+	if [[ ${i} -eq ${#repos[@]} ]]; then
+		repos[i]=${repo}
+		dirs[i]=$(get_repo_news_dir "${repo}")
+	fi
+	dir=${dirs[i]}
+}
+
+# return list of accepted languages
+accepted_languages() {
+	local lc=${LC_ALL:-${LANG}}
+	lc=${lc%%[^[:alpha:]]*}
+	[[ -n ${lc} && ${lc} != en ]] && echo ${lc}
+	echo en
+}
+
+### list action
+
+describe_list() {
+	echo "List news items"
+}
+
+do_list() {
+	package-manager &>/dev/null # for internal caching
+	local item stat repo dir header line title posted i=1
+	local ifs_save=${IFS-$' \t\n'}
+	local -a repos dirs
+
+	set -- $(find_items unread read)
+	write_list_start "News items:"
+	for item in "$@"; do
+		stat=${item%%/*}; item=${item#*/}
+		repo=${item%%/*}; item=${item#*/}
+		find_repo_dir ${repo}
+		header=$(read_item "${dir}" ${item} header)
+		IFS=$'\n'
+		for line in ${header}; do
+			case "${line%%: *}" in
+				Title) title=${line#*: } ;;
+				Posted) posted=${line#*: } ;;
+			esac
+		done
+		IFS=${ifs_save}
+		if [[ ${stat} = unread ]]; then
+			write_numbered_list_entry \
+				$((i++)) "$(highlight "${posted## }  (unread)  ${title## }")"
+		else
+			write_numbered_list_entry \
+				$((i++)) "${posted## }  (read)    ${title## }"
+		fi
+	done
+	[[ $# -eq 0 ]] && write_kv_list_entry "(none found)" ""
+}
+
+### count action
+
+describe_count() {
+	echo "Display number of news items"
+}
+
+describe_count_options() {
+	echo "new : Count unread news items (default)"
+	echo "all : Count all news items"
+}
+
+do_count() {
+	local status
+	[[ $1 = all ]] && status="unread read" || status="unread"
+	set -- $(find_items ${status})
+	echo $#
+}
+
+### read action
+
+describe_read() {
+	echo "Read news items"
+}
+
+describe_read_options() {
+	echo "new : Read unread news items"
+	echo "all : Read all news items"
+	echo "item : Number of item (from 'list' action)"
+}
+
+describe_read_parameters() {
+	echo "<item>..."
+}
+
+do_read() {
+	package-manager &>/dev/null # for internal caching
+	local -a items=( $(find_items unread read) ) repos dirs
+	local n=${#items[@]} item repo stat dir header line i seq repos_upd
+	local ifs_save=${IFS-$' \t\n'}
+
+	# expand special values "new" and "all"
+	if [[ $1 = new || $1 = all ]]; then
+		for (( i = 1; i <= n; i++ )); do
+			[[ $1 = new && ${items[i-1]%%/*} != unread ]] && break
+			seq="${seq} ${i}"
+		done
+		set -- ${seq}
+	fi
+
+	for i in "$@"; do
+		if ! is_number "${i}" || [[ ${i} -lt 1 || ${i} -gt ${#items[@]} ]]
+		then
+			write_warning_msg "Bad item number: ${i}"
+			continue
+		fi
+		item=${items[--i]}
+		stat=${item%%/*}; item=${item#*/}
+		repo=${item%%/*}; item=${item#*/}
+		find_repo_dir ${repo}
+		write_list_start "${item}"
+		header=$(read_item "${dir}" "${item}" header)
+		IFS=$'\n'
+		for line in ${header}; do
+			case "${line%%: *}" in
+				Title)
+					write_kv_list_entry \
+						"${line%%: *}" "$(highlight "${line#*: }")" ;;
+				Author|Posted|Revision)
+					write_kv_list_entry "${line%%: *}" "${line#*: }" ;;
+			esac
+		done
+		IFS=${ifs_save}
+		echo
+		read_item "${dir}" "${item}" body
+		echo
+
+		[[ ${stat} = unread ]] || continue
+		# move from "unread" to "read"
+		unset items[i]
+		items[n++]=read/${repo}/${item}
+		has ${repo} ${repos_upd} || repos_upd="${repos_upd} ${repo}"
+	done
+
+	# update lists of read/unread items
+	for repo in ${repos_upd}; do
+		write_item_list read ${repo} && write_item_list unread ${repo}
+	done
+}
+
+### unread action
+
+describe_unread() {
+	echo "Mark read news items as unread again"
+}
+
+describe_unread_options() {
+	echo "all : Mark all news items as unread"
+	echo "item : Number of item (from 'list' action)"
+}
+
+describe_unread_parameters() {
+	echo "<item>..."
+}
+
+do_unread() {
+	local -a items=( $(find_items unread read) )
+	local n=${#items[@]} item repo stat i seq repos_upd
+
+	# expand special value "all"
+	if [[ $1 = all ]]; then
+		for (( i = 1; i <= n; i++ )); do
+			seq="${seq} ${i}"
+		done
+		set -- ${seq}
+	fi
+
+	for i in "$@"; do
+		if ! is_number "${i}" || [[ ${i} -lt 1 || ${i} -gt ${#items[@]} ]]
+		then
+			write_warning_msg "Bad item number: ${i}"
+			continue
+		fi
+		item=${items[--i]}
+		stat=${item%%/*}; item=${item#*/}
+		repo=${item%%/*}; item=${item#*/}
+		[[ ${stat} = read ]] || continue
+		# move from "read" to "unread"
+		unset items[i]
+		items[n++]=unread/${repo}/${item}
+		has ${repo} ${repos_upd} || repos_upd="${repos_upd} ${repo}"
+	done
+
+	# update lists of unread/read items
+	for repo in ${repos_upd}; do
+		write_item_list unread ${repo} && write_item_list read ${repo}
+	done
+}
+
+### purge action
+
+describe_purge() {
+	echo "Purge read news"
+}
+
+do_purge() {
+	local -a items=( $(find_items read) )
+	local item i repos
+
+	# find repos with nonempty lists
+	for (( i = 0; i < ${#items[@]}; i++ )); do
+		item=${items[i]#*/}
+		has ${item%%/*} ${repos} || repos="${repos} ${item%%/*}"
+	done
+
+	# purge list of read items
+	items=()
+	for repo in ${repos}; do
+		write_item_list read ${repo}
+	done
+}


Property changes on: trunk/modules/news-tng.eselect
___________________________________________________________________
Name: svn:keywords
   + Author Date Id Revision