#
#
-# Copyright (C) 2010, 2011 Google Inc.
+# Copyright (C) 2010, 2011, 2012 Google Inc.
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
"""
import re
-import string # pylint: disable-msg=W0402
+import string # pylint: disable=W0402
+import logging
import pyparsing as pyp
from ganeti import errors
-from ganeti import netutils
from ganeti import utils
+from ganeti import compat
# Logic operators with one or more operands, each of which is a filter on its
# operator-specific value
OP_EQUAL = "="
OP_NOT_EQUAL = "!="
+OP_LT = "<"
+OP_LE = "<="
+OP_GT = ">"
+OP_GE = ">="
OP_REGEXP = "=~"
OP_CONTAINS = "=[]"
-#: Characters used for detecting user-written filters (see L{MaybeFilter})
-FILTER_DETECTION_CHARS = frozenset("()=/!~" + string.whitespace)
+#: Characters used for detecting user-written filters (see L{_CheckFilter})
+FILTER_DETECTION_CHARS = frozenset("()=/!~'\"\\<>" + string.whitespace)
+
+#: Characters used to detect globbing filters (see L{_CheckGlobbing})
+GLOB_DETECTION_CHARS = frozenset("*?")
def MakeSimpleFilter(namefield, values):
binopstbl = {
"==": OP_EQUAL,
"!=": OP_NOT_EQUAL,
+ "<": OP_LT,
+ "<=": OP_LE,
+ ">": OP_GT,
+ ">=": OP_GE,
}
binary_cond = (field_name + pyp.oneOf(binopstbl.keys()) + rval)
@rtype: list
"""
+ logging.debug("Parsing as query filter: %s", text)
+
if parser is None:
parser = BuildFilterParser()
" '%s': %s" % (text, err), err)
-def MaybeFilter(text):
- """Try to determine if a string is a filter or a name.
+def _CheckFilter(text):
+ """CHecks if a string could be a filter.
- If in doubt, this function treats a text as a name.
+ @rtype: bool
+
+ """
+ return bool(frozenset(text) & FILTER_DETECTION_CHARS)
+
+
+def _CheckGlobbing(text):
+ """Checks if a string could be a globbing pattern.
- @type text: string
- @param text: String to be examined
@rtype: bool
"""
- # Quick check for punctuation and whitespace
- if frozenset(text) & FILTER_DETECTION_CHARS:
- return True
+ return bool(frozenset(text) & GLOB_DETECTION_CHARS)
- try:
- netutils.Hostname.GetNormalizedName(text)
- except errors.OpPrereqError:
- # Not a valid hostname, treat as filter
- return True
- # Most probably a name
- return False
+def _MakeFilterPart(namefield, text, isnumeric=False):
+ """Generates filter for one argument.
+
+ """
+ if isnumeric:
+ try:
+ number = int(text)
+ except (TypeError, ValueError), err:
+ raise errors.OpPrereqError("Invalid job ID passed: %s" % str(err),
+ errors.ECODE_INVAL)
+ return [OP_EQUAL, namefield, number]
+ elif _CheckGlobbing(text):
+ return [OP_REGEXP, namefield, utils.DnsNameGlobPattern(text)]
+ else:
+ return [OP_EQUAL, namefield, text]
+
+
+def MakeFilter(args, force_filter, namefield=None, isnumeric=False):
+ """Try to make a filter from arguments to a command.
+
+ If the name could be a filter it is parsed as such. If it's just a globbing
+ pattern, e.g. "*.site", such a filter is constructed. As a last resort the
+ names are treated just as a plain name filter.
+
+ @type args: list of string
+ @param args: Arguments to command
+ @type force_filter: bool
+ @param force_filter: Whether to force treatment as a full-fledged filter
+ @type namefield: string
+ @param namefield: Name of field to use for simple filters (use L{None} for
+ a default of "name")
+ @type isnumeric: bool
+ @param isnumeric: Whether the namefield type is numeric, as opposed to
+ the default string type; this influences how the filter is built
+ @rtype: list
+ @return: Query filter
+
+ """
+ if namefield is None:
+ namefield = "name"
+
+ if (force_filter or
+ (args and len(args) == 1 and _CheckFilter(args[0]))):
+ try:
+ (filter_text, ) = args
+ except (TypeError, ValueError):
+ raise errors.OpPrereqError("Exactly one argument must be given as a"
+ " filter", errors.ECODE_INVAL)
+
+ result = ParseFilter(filter_text)
+ elif args:
+ result = [OP_OR] + map(compat.partial(_MakeFilterPart, namefield,
+ isnumeric=isnumeric), args)
+ else:
+ result = None
+
+ return result