Mercurial > octave
view scripts/pkg/private/get_description.m @ 21616:32cd60419b61
pkg: add support for [a-z.+-~] characters on package version number string.
* pkg/private/get_description.m: currently pkg enforces a x.y.z (major,
minor, and patch) numeric style for the string representing a package
version. In addition, it will silently append a ".0" if the string is
missing the patch version which causes weird errors for downstream
packagers. However, there seems to be no reason in the code for this
limitation which prevents 'x.y.z+' or 'x.y.z-rcN'. A real limitation we
will have is that version string will be used in the package filepath.
This change just expands the valid characters for the version string.
It does not change the requirement when installing packages with the
-forge option though (but Octave forge packages only have the x.y.z
version string anyway).
author | Carnë Draug <carandraug@octave.org> |
---|---|
date | Tue, 12 Apr 2016 19:11:27 +0100 |
parents | 9ccd64201b4d |
children | 1fff60b89786 |
line wrap: on
line source
## Copyright (C) 2005-2015 Søren Hauberg ## Copyright (C) 2010 VZLU Prague, a.s. ## ## This file is part of Octave. ## ## Octave 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. ## ## Octave 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 Octave; see the file COPYING. If not, see ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- ## @deftypefn {} {@var{desc} =} get_description (@var{filename}) ## Undocumented internal function. ## @end deftypefn ## Parse the DESCRIPTION file. function desc = get_description (filename) [fid, msg] = fopen (filename, "r"); if (fid == -1) error ("the DESCRIPTION file %s could not be read: %s", filename, msg); endif desc = struct (); line = fgetl (fid); while (line != -1) if (line(1) == "#") ## Comments, do nothing. elseif (isspace (line(1))) ## Continuation lines if (exist ("keyword", "var") && isfield (desc, keyword)) desc.(keyword) = [desc.(keyword) " " deblank(line)]; endif else ## Keyword/value pair colon = find (line == ":"); if (length (colon) == 0) disp ("skipping line"); else colon = colon(1); keyword = tolower (strtrim (line(1:colon-1))); value = strtrim (line (colon+1:end)); if (length (value) == 0) fclose (fid); error ("The keyword '%s' of the package '%s' has an empty value", keyword, desc.name); endif desc.(keyword) = value; endif endif line = fgetl (fid); endwhile fclose (fid); ## Make sure all is okay. needed_fields = {"name", "version", "date", "title", ... "author", "maintainer", "description"}; for f = needed_fields if (! isfield (desc, f{1})) error ("description is missing needed field %s", f{1}); endif endfor if (! is_valid_pkg_version_string (desc.version)) error ("invalid version string '%s'", desc.version); endif if (isfield (desc, "depends")) desc.depends = fix_depends (desc.depends); else desc.depends = ""; endif desc.name = tolower (desc.name); endfunction ## Make sure the depends field is of the right format. ## This function returns a cell of structures with the following fields: ## package, version, operator function deps_cell = fix_depends (depends) deps = strtrim (ostrsplit (tolower (depends), ",")); deps_cell = cell (1, length (deps)); dep_pat = ... '\s*(?<name>[-\w]+)\s*(\(\s*(?<op>[<>=]+)\s*(?<ver>\d+\.\d+(\.\d+)*)\s*\))*\s*'; ## For each dependency. for i = 1:length (deps) dep = deps{i}; [start, nm] = regexp (dep, dep_pat, 'start', 'names'); ## Is the dependency specified ## in the correct format? if (! isempty (start)) package = tolower (strtrim (nm.name)); ## Does the dependency specify a version ## Example: package(>= version). if (! isempty (nm.ver)) operator = nm.op; if (! any (strcmp (operator, {">", ">=", "<=", "<", "=="}))) error ("unsupported operator: %s", operator); endif if (! is_valid_pkg_version_string (nm.ver)) error ("invalid dependency version string '%s'", nm.ver); endif else ## If no version is specified for the dependency ## we say that the version should be greater than ## or equal to "0.0.0". package = tolower (strtrim (dep)); operator = ">="; nm.ver = "0.0.0"; endif deps_cell{i} = struct ("package", package, "operator", operator, "version", nm.ver); else error ("incorrect syntax for dependency '%s' in the DESCRIPTION file\n", dep); endif endfor endfunction function [valid] = is_valid_pkg_version_string (str) ## We are limiting ourselves to this set of characters because the ## version will appear on the filepath. The portable character, according ## to http://pubs.opengroup.org/onlinepubs/9699919799/basedefs/V1_chap03.html#tag_03_278 ## is [A-Za-z0-9\.\_\-]. However, this is very limited. We expand this ## set with the characters supported by Debian with the exception of ":" ## (we do not support ":" (colon) because that's the Octave path separator. valid = numel (regexp (str, '[^0-9a-zA-Z\.\+\-\~]')) == 0; endfunction