Differential D11304 Diff 38147 Mk/Scripts/check-desktop-entries.sh

Changeset View

Standalone View

Mk/Scripts/check-desktop-entries.sh

This file was added.

				#!/bin/sh
				# $FreeBSD$
				#
				# MAINTAINER: portmgr@FreeBSD.org

				set -e

				. "${dp_SCRIPTSDIR}/functions.sh"

				validate_env dp_CURDIR dp_ECHO_CMD dp_ECHO_MSG dp_EXPR dp_GREP dp_PKGNAME \
				dp_SED dp_TR dp_MAKE

				[ -n "${DEBUG_MK_SCRIPTS}" -o -n "${DEBUG_MK_SCRIPTS_CHECK_DESKTOP_ENTRIES}" ] && set -x

				set -u

				# http://standards.freedesktop.org/menu-spec/menu-spec-latest.html
				DESKTOP_CATEGORIES_MAIN='AudioVideo Audio Video Development Education Game
				Graphics Network Office Science Settings System Utility'
				DESKTOP_CATEGORIES_ADDITIONAL='Building Debugger IDE GUIDesigner Profiling
				RevisionControl Translation Calendar ContactManagement Database Dictionary
				Chart Email Finance FlowChart PDA ProjectManagement Presentation Spreadsheet
				WordProcessor 2DGraphics VectorGraphics RasterGraphics 3DGraphics Scanning OCR
				Photography Publishing Viewer TextTools DesktopSettings HardwareSettings
				Printing PackageManager Dialup InstantMessaging Chat IRCClient Feed
				FileTransfer HamRadio News P2P RemoteAccess Telephony TelephonyTools
				VideoConference WebBrowser WebDevelopment Midi Mixer Sequencer Tuner TV
				AudioVideoEditing Player Recorder DiscBurning ActionGame AdventureGame
				ArcadeGame BoardGame BlocksGame CardGame KidsGame LogicGame RolePlaying Shooter
				Simulation SportsGame StrategyGame Art Construction Music Languages
				ArtificialIntelligence Astronomy Biology Chemistry ComputerScience
				DataVisualization Economy Electricity Geography Geology Geoscience History
				Humanities ImageProcessing Literature Maps Math NumericalAnalysis
				MedicalSoftware Physics Robotics Spirituality Sports ParallelComputing
				Amusement Archiving Compression Electronics Emulator Engineering FileTools
				FileManager TerminalEmulator Filesystem Monitor Security Accessibility
				Calculator Clock TextEditor Documentation Adult Core KDE GNOME MATE XFCE GTK Qt
				Motif Java ConsoleOnly'
				DESKTOP_CATEGORIES_RESERVED='Screensaver TrayIcon Applet Shell'

				VALID_DESKTOP_CATEGORIES="${dp_VALID_DESKTOP_CATEGORIES} ${DESKTOP_CATEGORIES_MAIN} ${DESKTOP_CATEGORIES_ADDITIONAL} ${DESKTOP_CATEGORIES_RESERVED}"

				if [ $(${dp_EXPR} $# % 6) -ne 0 ]; then
				${dp_ECHO_MSG} "${dp_PKGNAME}: Makefile error: the DESKTOP_ENTRIES list must contain one or more groups of 6 elements"
				exit 1
				fi

				num=0

				while [ $# -ge 6 ]; do
				num=$(${dp_EXPR} ${num} + 1)
				entry="#${num}"

				Name="${1}"
				Comment="${2}"
				Icon="${3}"
				Exec="${4}"
				Categories="${5}"
				StartupNotify="${6}"

				shift 6

				if [ -n "${Exec}" ]; then
				entry="${entry} (${Exec})"
				elif [ -n "${Name}" ]; then
				entry="${entry} (${Name})"
				fi

				if [ -z "${Name}" ]; then
				${dp_ECHO_MSG} "${dp_PKGNAME}: Makefile error: in desktop entry ${entry}: field 1 (Name) is empty"
				exit 1
				fi

				if ${dp_EXPR} '(' "${Icon}" : '.\.xpm$' ')' '\|' '(' ${Icon} : '.\.png$' ')' '\|' '(' ${Icon} : '.*\.svg$' ')' > /dev/null; then
				if ! echo "${Icon}" \| ${dp_GREP} -qe '^/' ; then
				jillesUnsubmitted Not Done Inline Actions The previous code using echo\|grep matched the suffix case-insensitively. jilles: The previous code using echo\|grep matched the suffix case-insensitively.
				matAuthorUnsubmitted Not Done Inline Actions True. On the other hand, I did check beforehand, there are no cases where the files are not lower cased. mat: True. On the other hand, I did check beforehand, there are no cases where the files are not…
				${dp_ECHO_MSG} "${dp_PKGNAME}: Makefile warning: in desktop entry ${entry}: field 3 (Icon) should be either absolute path or icon name without extension if installed icons follow Icon Theme Specification"
				jillesUnsubmitted Not Done Inline Actions This will work with the current implementation of expr, but it is not POSIX-compliant, since POSIX leaves it unspecified whether an initial `^` is special (the expression being implicitly anchored anyway). jilles: This will work with the current implementation of expr, but it is not POSIX-compliant, since…
				matAuthorUnsubmitted Not Done Inline Actions But we do not run in the os called POSIX, we run on the OS called FreeBSD, where the behavior is currently very well defined. If the behavior ever changes later, then all the code using it will need to change. We live in the now, with an eye of what is in the work, and not using tools because of a vague possibilty that one day the way they work may change is not how I see doing things. I mean, I could never do anything if it was the case. mat: But we do not run in the os called POSIX, we run on the OS called FreeBSD, where the behavior…
				jillesUnsubmitted Not Done Inline Actions Sorry for being less constructive here. The desired behaviour can be implemented using POSIX-compliant expr as `${dp_EXPR} "x${Icon}" : x/`. My point is not that we should restrict ourselves to POSIX features at all cost, but that an implementation using only POSIX features is preferable to an implementation using extensions if they are similar in other respects. In some situations, non-standard features unique to a system are more likely to change than standard features common with other systems. Given that this feature (^ in : regular expression) is implemented the same way by GNU expr, it seems not unlikely to change, though. jilles: Sorry for being less constructive here. The desired behaviour can be implemented using POSIX…
				fi
				fi
				jillesUnsubmitted Done Inline Actions The expr syntax is invalid because `/` is interpreted as a division operator. Perhaps case ${Icon} in /) ;; ) ${dp_ECHO_MSG} "${dp_PKGNAME}: Makefile warning: in desktop entry ${entry}: field 3 (Icon) should be either absolute path or icon name without extension if installed icons follow Icon Theme Specification" ;; esac jilles: The expr syntax is invalid because `/` is interpreted as a division operator. Perhaps case…

				if [ -z "${Exec}" ]; then
				${dp_ECHO_MSG} "${dp_PKGNAME}: Makefile error: in desktop entry ${entry}: field 4 (Exec) is empty"
				exit 1
				fi

				if [ -n "${Categories}" ]; then
				for c in $(${dp_ECHO_CMD} "${Categories}" \| ${dp_TR} ';' ' '); do
				if ! ${dp_ECHO_CMD} ${VALID_DESKTOP_CATEGORIES} \| ${dp_GREP} -wq ${c}; then
				${dp_ECHO_CMD} "${dp_PKGNAME}: Makefile warning: in desktop entry ${entry}: category ${c} is not a valid desktop category"
				fi
				done

				if ! ${dp_ECHO_CMD} "${Categories}" \| ${dp_GREP} -Eq "$(${dp_ECHO_CMD} ${DESKTOP_CATEGORIES_MAIN} \| ${dp_SED} -E 's,[[:blank:]]+,\\|,g')"; then
				${dp_ECHO_CMD} "${dp_PKGNAME}: Makefile warning: in desktop entry ${entry}: field 5 (Categories) must contain at least one main desktop category (make -VDESKTOP_CATEGORIES_MAIN)"
				fi

				if ! ${dp_EXPR} "${Categories}" : '.*;$' > /dev/null; then
				${dp_ECHO_MSG} "${dp_PKGNAME}: Makefile error: in desktop entry ${entry}: field 5 (Categories) does not end with a semicolon"
				exit 1
				fi
				else
				if [ -z "$(cd ${dp_CURDIR} && ${dp_MAKE} desktop-categories)" ]; then
				${dp_ECHO_MSG} "${dp_PKGNAME}: Makefile error: in desktop entry ${entry}: field 5 (Categories) is empty and could not be deduced from the CATEGORIES variable"
				exit 1
				fi
				fi

				if [ "${StartupNotify}" != "true" ] && [ "${StartupNotify}" != "false" ] && [ -n "${StartupNotify}" ]; then
				${dp_ECHO_MSG} "${dp_PKGNAME}: Makefile error: in desktop entry ${entry}: field 6 (StartupNotify) is not \"true\", \"false\" or \"\"(empty)"
				exit 1
				fi
				done