utils.py 57.3 KB
Newer Older
Iustin Pop's avatar
Iustin Pop committed
1
#
Iustin Pop's avatar
Iustin Pop committed
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
#

# Copyright (C) 2006, 2007 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
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program 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 this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
# 02110-1301, USA.


22
23
24
25
"""Ganeti utility module.

This module holds functions that can be used in both daemons (all) and
the command line scripts.
26

Iustin Pop's avatar
Iustin Pop committed
27
28
29
30
31
"""


import os
import time
32
import subprocess
Iustin Pop's avatar
Iustin Pop committed
33
34
35
36
import re
import socket
import tempfile
import shutil
37
import errno
38
import pwd
Guido Trotter's avatar
Guido Trotter committed
39
import itertools
40
41
import select
import fcntl
42
import resource
43
import logging
Michael Hanselmann's avatar
Michael Hanselmann committed
44
import signal
45
46

from cStringIO import StringIO
Iustin Pop's avatar
Iustin Pop committed
47

48
49
50
51
52
53
try:
  from hashlib import sha1
except ImportError:
  import sha
  sha1 = sha.new

Iustin Pop's avatar
Iustin Pop committed
54
from ganeti import errors
Iustin Pop's avatar
Iustin Pop committed
55
from ganeti import constants
Iustin Pop's avatar
Iustin Pop committed
56

57

Iustin Pop's avatar
Iustin Pop committed
58
59
60
_locksheld = []
_re_shell_unquoted = re.compile('^[-.,=:/_+@A-Za-z0-9]+$')

61
debug_locks = False
62
63

#: when set to True, L{RunCmd} is disabled
64
no_fork = False
65

66

Iustin Pop's avatar
Iustin Pop committed
67
class RunResult(object):
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
  """Holds the result of running external programs.

  @type exit_code: int
  @ivar exit_code: the exit code of the program, or None (if the program
      didn't exit())
  @type signal: int or None
  @ivar signal: the signal that caused the program to finish, or None
      (if the program wasn't terminated by a signal)
  @type stdout: str
  @ivar stdout: the standard output of the program
  @type stderr: str
  @ivar stderr: the standard error of the program
  @type failed: boolean
  @ivar failed: True in case the program was
      terminated by a signal or exited with a non-zero exit code
  @ivar fail_reason: a string detailing the termination reason
Iustin Pop's avatar
Iustin Pop committed
84
85
86
87
88
89

  """
  __slots__ = ["exit_code", "signal", "stdout", "stderr",
               "failed", "fail_reason", "cmd"]


Iustin Pop's avatar
Iustin Pop committed
90
  def __init__(self, exit_code, signal_, stdout, stderr, cmd):
Iustin Pop's avatar
Iustin Pop committed
91
92
    self.cmd = cmd
    self.exit_code = exit_code
Iustin Pop's avatar
Iustin Pop committed
93
    self.signal = signal_
Iustin Pop's avatar
Iustin Pop committed
94
95
    self.stdout = stdout
    self.stderr = stderr
Iustin Pop's avatar
Iustin Pop committed
96
    self.failed = (signal_ is not None or exit_code != 0)
Iustin Pop's avatar
Iustin Pop committed
97
98
99
100
101
102
103
104

    if self.signal is not None:
      self.fail_reason = "terminated by signal %s" % self.signal
    elif self.exit_code is not None:
      self.fail_reason = "exited with exit code %s" % self.exit_code
    else:
      self.fail_reason = "unable to determine termination reason"

105
106
107
    if self.failed:
      logging.debug("Command '%s' failed (%s); output: %s",
                    self.cmd, self.fail_reason, self.output)
108

Iustin Pop's avatar
Iustin Pop committed
109
110
111
112
113
114
115
116
117
  def _GetOutput(self):
    """Returns the combined stdout and stderr for easier usage.

    """
    return self.stdout + self.stderr

  output = property(_GetOutput, None, None, "Return full output")


118
def RunCmd(cmd, env=None, output=None, cwd='/'):
Iustin Pop's avatar
Iustin Pop committed
119
120
121
122
123
  """Execute a (shell) command.

  The command should not read from its standard input, as it will be
  closed.

124
  @type  cmd: string or list
125
  @param cmd: Command to run
126
  @type env: dict
127
  @param env: Additional environment
128
  @type output: str
129
  @param output: if desired, the output of the command can be
130
131
      saved in a file instead of the RunResult instance; this
      parameter denotes the file name (if not None)
132
133
134
  @type cwd: string
  @param cwd: if specified, will be used as the working
      directory for the command; the default will be /
135
  @rtype: L{RunResult}
136
  @return: RunResult instance
Michael Hanselmann's avatar
Michael Hanselmann committed
137
  @raise errors.ProgrammerError: if we call this when forks are disabled
Iustin Pop's avatar
Iustin Pop committed
138
139

  """
140
141
142
  if no_fork:
    raise errors.ProgrammerError("utils.RunCmd() called with fork() disabled")

Iustin Pop's avatar
Iustin Pop committed
143
144
  if isinstance(cmd, list):
    cmd = [str(val) for val in cmd]
145
146
147
148
149
    strcmd = " ".join(cmd)
    shell = False
  else:
    strcmd = cmd
    shell = True
150
  logging.debug("RunCmd '%s'", strcmd)
151
152
153
154
155
156

  cmd_env = os.environ.copy()
  cmd_env["LC_ALL"] = "C"
  if env is not None:
    cmd_env.update(env)

157
158
159
160
161
162
163
164
165
166
167
168
  try:
    if output is None:
      out, err, status = _RunCmdPipe(cmd, cmd_env, shell, cwd)
    else:
      status = _RunCmdFile(cmd, cmd_env, shell, output, cwd)
      out = err = ""
  except OSError, err:
    if err.errno == errno.ENOENT:
      raise errors.OpExecError("Can't execute '%s': not found (%s)" %
                               (strcmd, err))
    else:
      raise
169
170
171
172
173
174
175
176
177
178

  if status >= 0:
    exitcode = status
    signal_ = None
  else:
    exitcode = None
    signal_ = -status

  return RunResult(exitcode, signal_, out, err, strcmd)

179

180
def _RunCmdPipe(cmd, env, via_shell, cwd):
181
182
183
184
185
186
187
188
  """Run a command and return its output.

  @type  cmd: string or list
  @param cmd: Command to run
  @type env: dict
  @param env: The environment to use
  @type via_shell: bool
  @param via_shell: if we should run via the shell
189
190
  @type cwd: string
  @param cwd: the working directory for the program
191
192
193
194
  @rtype: tuple
  @return: (out, err, status)

  """
195
  poller = select.poll()
196
  child = subprocess.Popen(cmd, shell=via_shell,
197
198
199
                           stderr=subprocess.PIPE,
                           stdout=subprocess.PIPE,
                           stdin=subprocess.PIPE,
200
201
                           close_fds=True, env=env,
                           cwd=cwd)
202
203

  child.stdin.close()
204
205
206
207
208
209
210
211
212
213
214
215
216
  poller.register(child.stdout, select.POLLIN)
  poller.register(child.stderr, select.POLLIN)
  out = StringIO()
  err = StringIO()
  fdmap = {
    child.stdout.fileno(): (out, child.stdout),
    child.stderr.fileno(): (err, child.stderr),
    }
  for fd in fdmap:
    status = fcntl.fcntl(fd, fcntl.F_GETFL)
    fcntl.fcntl(fd, fcntl.F_SETFL, status | os.O_NONBLOCK)

  while fdmap:
217
218
219
220
221
222
223
224
225
226
227
228
    try:
      pollresult = poller.poll()
    except EnvironmentError, eerr:
      if eerr.errno == errno.EINTR:
        continue
      raise
    except select.error, serr:
      if serr[0] == errno.EINTR:
        continue
      raise

    for fd, event in pollresult:
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
      if event & select.POLLIN or event & select.POLLPRI:
        data = fdmap[fd][1].read()
        # no data from read signifies EOF (the same as POLLHUP)
        if not data:
          poller.unregister(fd)
          del fdmap[fd]
          continue
        fdmap[fd][0].write(data)
      if (event & select.POLLNVAL or event & select.POLLHUP or
          event & select.POLLERR):
        poller.unregister(fd)
        del fdmap[fd]

  out = out.getvalue()
  err = err.getvalue()
Iustin Pop's avatar
Iustin Pop committed
244
245

  status = child.wait()
246
  return out, err, status
Iustin Pop's avatar
Iustin Pop committed
247

248

249
def _RunCmdFile(cmd, env, via_shell, output, cwd):
250
251
252
253
254
255
256
257
258
259
  """Run a command and save its output to a file.

  @type  cmd: string or list
  @param cmd: Command to run
  @type env: dict
  @param env: The environment to use
  @type via_shell: bool
  @param via_shell: if we should run via the shell
  @type output: str
  @param output: the filename in which to save the output
260
261
  @type cwd: string
  @param cwd: the working directory for the program
262
263
264
265
266
267
268
269
270
271
  @rtype: int
  @return: the exit status

  """
  fh = open(output, "a")
  try:
    child = subprocess.Popen(cmd, shell=via_shell,
                             stderr=subprocess.STDOUT,
                             stdout=fh,
                             stdin=subprocess.PIPE,
272
273
                             close_fds=True, env=env,
                             cwd=cwd)
274
275
276
277
278
279

    child.stdin.close()
    status = child.wait()
  finally:
    fh.close()
  return status
Iustin Pop's avatar
Iustin Pop committed
280
281
282
283
284
285
286
287


def RemoveFile(filename):
  """Remove a file ignoring some errors.

  Remove a file, ignoring non-existing ones or directories. Other
  errors are passed.

288
289
290
  @type filename: str
  @param filename: the file to be removed

Iustin Pop's avatar
Iustin Pop committed
291
292
293
294
  """
  try:
    os.unlink(filename)
  except OSError, err:
295
    if err.errno not in (errno.ENOENT, errno.EISDIR):
Iustin Pop's avatar
Iustin Pop committed
296
297
298
      raise


299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
def RenameFile(old, new, mkdir=False, mkdir_mode=0750):
  """Renames a file.

  @type old: string
  @param old: Original path
  @type new: string
  @param new: New path
  @type mkdir: bool
  @param mkdir: Whether to create target directory if it doesn't exist
  @type mkdir_mode: int
  @param mkdir_mode: Mode for newly created directories

  """
  try:
    return os.rename(old, new)
  except OSError, err:
    # In at least one use case of this function, the job queue, directory
    # creation is very rare. Checking for the directory before renaming is not
    # as efficient.
    if mkdir and err.errno == errno.ENOENT:
      # Create directory and try again
      os.makedirs(os.path.dirname(new), mkdir_mode)
      return os.rename(old, new)
    raise


Iustin Pop's avatar
Iustin Pop committed
325
326
327
328
329
330
def _FingerprintFile(filename):
  """Compute the fingerprint of a file.

  If the file does not exist, a None will be returned
  instead.

331
332
333
334
335
  @type filename: str
  @param filename: the filename to checksum
  @rtype: str
  @return: the hex digest of the sha checksum of the contents
      of the file
Iustin Pop's avatar
Iustin Pop committed
336
337
338
339
340
341
342

  """
  if not (os.path.exists(filename) and os.path.isfile(filename)):
    return None

  f = open(filename)

343
  fp = sha1()
Iustin Pop's avatar
Iustin Pop committed
344
345
346
347
348
349
350
351
352
353
354
355
356
  while True:
    data = f.read(4096)
    if not data:
      break

    fp.update(data)

  return fp.hexdigest()


def FingerprintFiles(files):
  """Compute fingerprints for a list of files.

357
358
359
360
361
  @type files: list
  @param files: the list of filename to fingerprint
  @rtype: dict
  @return: a dictionary filename: fingerprint, holding only
      existing files
Iustin Pop's avatar
Iustin Pop committed
362
363
364
365
366
367
368
369
370
371
372
373

  """
  ret = {}

  for filename in files:
    cksum = _FingerprintFile(filename)
    if cksum:
      ret[filename] = cksum

  return ret


374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
def ForceDictType(target, key_types, allowed_values=None):
  """Force the values of a dict to have certain types.

  @type target: dict
  @param target: the dict to update
  @type key_types: dict
  @param key_types: dict mapping target dict keys to types
                    in constants.ENFORCEABLE_TYPES
  @type allowed_values: list
  @keyword allowed_values: list of specially allowed values

  """
  if allowed_values is None:
    allowed_values = []

389
390
391
392
  if not isinstance(target, dict):
    msg = "Expected dictionary, got '%s'" % target
    raise errors.TypeEnforcementError(msg)

393
394
395
396
397
398
399
400
  for key in target:
    if key not in key_types:
      msg = "Unknown key '%s'" % key
      raise errors.TypeEnforcementError(msg)

    if target[key] in allowed_values:
      continue

Iustin Pop's avatar
Iustin Pop committed
401
402
403
    ktype = key_types[key]
    if ktype not in constants.ENFORCEABLE_TYPES:
      msg = "'%s' has non-enforceable type %s" % (key, ktype)
404
405
      raise errors.ProgrammerError(msg)

Iustin Pop's avatar
Iustin Pop committed
406
    if ktype == constants.VTYPE_STRING:
407
408
409
410
411
412
      if not isinstance(target[key], basestring):
        if isinstance(target[key], bool) and not target[key]:
          target[key] = ''
        else:
          msg = "'%s' (value %s) is not a valid string" % (key, target[key])
          raise errors.TypeEnforcementError(msg)
Iustin Pop's avatar
Iustin Pop committed
413
    elif ktype == constants.VTYPE_BOOL:
414
415
416
417
418
419
420
421
422
423
424
425
      if isinstance(target[key], basestring) and target[key]:
        if target[key].lower() == constants.VALUE_FALSE:
          target[key] = False
        elif target[key].lower() == constants.VALUE_TRUE:
          target[key] = True
        else:
          msg = "'%s' (value %s) is not a valid boolean" % (key, target[key])
          raise errors.TypeEnforcementError(msg)
      elif target[key]:
        target[key] = True
      else:
        target[key] = False
Iustin Pop's avatar
Iustin Pop committed
426
    elif ktype == constants.VTYPE_SIZE:
427
428
429
430
431
432
      try:
        target[key] = ParseUnit(target[key])
      except errors.UnitParseError, err:
        msg = "'%s' (value %s) is not a valid size. error: %s" % \
              (key, target[key], err)
        raise errors.TypeEnforcementError(msg)
Iustin Pop's avatar
Iustin Pop committed
433
    elif ktype == constants.VTYPE_INT:
434
435
436
437
438
439
440
      try:
        target[key] = int(target[key])
      except (ValueError, TypeError):
        msg = "'%s' (value %s) is not a valid integer" % (key, target[key])
        raise errors.TypeEnforcementError(msg)


Iustin Pop's avatar
Iustin Pop committed
441
442
443
def IsProcessAlive(pid):
  """Check if a given pid exists on the system.

444
445
  @note: zombie status is not handled, so zombie processes
      will be returned as alive
446
447
448
449
  @type pid: int
  @param pid: the process ID to check
  @rtype: boolean
  @return: True if the process exists
Iustin Pop's avatar
Iustin Pop committed
450
451

  """
452
453
454
  if pid <= 0:
    return False

Iustin Pop's avatar
Iustin Pop committed
455
  try:
456
457
458
    os.stat("/proc/%d/status" % pid)
    return True
  except EnvironmentError, err:
459
    if err.errno in (errno.ENOENT, errno.ENOTDIR):
Iustin Pop's avatar
Iustin Pop committed
460
      return False
461
    raise
Iustin Pop's avatar
Iustin Pop committed
462
463


464
def ReadPidFile(pidfile):
465
  """Read a pid from a file.
466

467
468
469
  @type  pidfile: string
  @param pidfile: path to the file containing the pid
  @rtype: int
470
  @return: The process id, if the file exists and contains a valid PID,
471
           otherwise 0
472
473
474
475

  """
  try:
    pf = open(pidfile, 'r')
476
477
478
479
  except EnvironmentError, err:
    if err.errno != errno.ENOENT:
      logging.exception("Can't read pid file?!")
    return 0
480
481
482

  try:
    pid = int(pf.read())
483
  except ValueError, err:
484
    logging.info("Can't parse pid file contents", exc_info=True)
485
    return 0
486

487
  return pid
488
489


Iustin Pop's avatar
Iustin Pop committed
490
491
492
493
def MatchNameComponent(key, name_list):
  """Try to match a name against a list.

  This function will try to match a name like test1 against a list
494
495
496
497
498
  like C{['test1.example.com', 'test2.example.com', ...]}. Against
  this list, I{'test1'} as well as I{'test1.example'} will match, but
  not I{'test1.ex'}. A multiple match will be considered as no match
  at all (e.g. I{'test1'} against C{['test1.example.com',
  'test1.example.org']}).
Iustin Pop's avatar
Iustin Pop committed
499

500
501
502
503
  @type key: str
  @param key: the name to be searched
  @type name_list: list
  @param name_list: the list of strings against which to search the key
Iustin Pop's avatar
Iustin Pop committed
504

505
506
507
  @rtype: None or str
  @return: None if there is no match I{or} if there are multiple matches,
      otherwise the element from the list which matches
Iustin Pop's avatar
Iustin Pop committed
508
509
510
511
512
513
514
515
516

  """
  mo = re.compile("^%s(\..*)?$" % re.escape(key))
  names_filtered = [name for name in name_list if mo.match(name) is not None]
  if len(names_filtered) != 1:
    return None
  return names_filtered[0]


517
class HostInfo:
518
  """Class implementing resolver and hostname functionality
519
520

  """
521
  def __init__(self, name=None):
522
523
    """Initialize the host name object.

524
525
    If the name argument is not passed, it will use this system's
    name.
526
527

    """
528
529
530
531
532
    if name is None:
      name = self.SysName()

    self.query = name
    self.name, self.aliases, self.ipaddrs = self.LookupHostname(name)
533
534
    self.ip = self.ipaddrs[0]

535
536
537
538
539
540
  def ShortName(self):
    """Returns the hostname without domain.

    """
    return self.name.split('.')[0]

541
542
543
  @staticmethod
  def SysName():
    """Return the current system's name.
544

545
    This is simply a wrapper over C{socket.gethostname()}.
Iustin Pop's avatar
Iustin Pop committed
546

547
548
    """
    return socket.gethostname()
Iustin Pop's avatar
Iustin Pop committed
549

550
551
552
  @staticmethod
  def LookupHostname(hostname):
    """Look up hostname
Iustin Pop's avatar
Iustin Pop committed
553

554
555
    @type hostname: str
    @param hostname: hostname to look up
556

557
558
559
560
    @rtype: tuple
    @return: a tuple (name, aliases, ipaddrs) as returned by
        C{socket.gethostbyname_ex}
    @raise errors.ResolverError: in case of errors in resolving
561
562
563
564
565
566
567

    """
    try:
      result = socket.gethostbyname_ex(hostname)
    except socket.gaierror, err:
      # hostname not found in DNS
      raise errors.ResolverError(hostname, err.args[0], err.args[1])
Iustin Pop's avatar
Iustin Pop committed
568

569
    return result
Iustin Pop's avatar
Iustin Pop committed
570
571
572
573
574


def ListVolumeGroups():
  """List volume groups and their size

575
576
577
578
  @rtype: dict
  @return:
       Dictionary with keys volume name and values
       the size of the volume
Iustin Pop's avatar
Iustin Pop committed
579
580
581
582
583
584
585
586
587
588
589
590
591

  """
  command = "vgs --noheadings --units m --nosuffix -o name,size"
  result = RunCmd(command)
  retval = {}
  if result.failed:
    return retval

  for line in result.stdout.splitlines():
    try:
      name, size = line.split()
      size = int(float(size))
    except (IndexError, ValueError), err:
592
      logging.error("Invalid output from vgs (%s): %s", err, line)
Iustin Pop's avatar
Iustin Pop committed
593
594
595
596
597
598
599
600
601
602
      continue

    retval[name] = size

  return retval


def BridgeExists(bridge):
  """Check whether the given bridge exists in the system

603
604
605
606
  @type bridge: str
  @param bridge: the bridge name to check
  @rtype: boolean
  @return: True if it does
Iustin Pop's avatar
Iustin Pop committed
607
608
609
610
611
612
613
614

  """
  return os.path.isdir("/sys/class/net/%s/bridge" % bridge)


def NiceSort(name_list):
  """Sort a list of strings based on digit and non-digit groupings.

615
616
617
  Given a list of names C{['a1', 'a10', 'a11', 'a2']} this function
  will sort the list in the logical order C{['a1', 'a2', 'a10',
  'a11']}.
Iustin Pop's avatar
Iustin Pop committed
618
619
620
621
622

  The sort algorithm breaks each name in groups of either only-digits
  or no-digits. Only the first eight such groups are considered, and
  after that we just use what's left of the string.

623
624
625
626
  @type name_list: list
  @param name_list: the names to be sorted
  @rtype: list
  @return: a copy of the name list sorted with our algorithm
Iustin Pop's avatar
Iustin Pop committed
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651

  """
  _SORTER_BASE = "(\D+|\d+)"
  _SORTER_FULL = "^%s%s?%s?%s?%s?%s?%s?%s?.*$" % (_SORTER_BASE, _SORTER_BASE,
                                                  _SORTER_BASE, _SORTER_BASE,
                                                  _SORTER_BASE, _SORTER_BASE,
                                                  _SORTER_BASE, _SORTER_BASE)
  _SORTER_RE = re.compile(_SORTER_FULL)
  _SORTER_NODIGIT = re.compile("^\D*$")
  def _TryInt(val):
    """Attempts to convert a variable to integer."""
    if val is None or _SORTER_NODIGIT.match(val):
      return val
    rval = int(val)
    return rval

  to_sort = [([_TryInt(grp) for grp in _SORTER_RE.match(name).groups()], name)
             for name in name_list]
  to_sort.sort()
  return [tup[1] for tup in to_sort]


def TryConvert(fn, val):
  """Try to convert a value ignoring errors.

652
653
654
655
656
657
658
659
660
661
  This function tries to apply function I{fn} to I{val}. If no
  C{ValueError} or C{TypeError} exceptions are raised, it will return
  the result, else it will return the original value. Any other
  exceptions are propagated to the caller.

  @type fn: callable
  @param fn: function to apply to the value
  @param val: the value to be converted
  @return: The converted value if the conversion was successful,
      otherwise the original value.
Iustin Pop's avatar
Iustin Pop committed
662
663
664
665

  """
  try:
    nv = fn(val)
Michael Hanselmann's avatar
Michael Hanselmann committed
666
  except (ValueError, TypeError):
Iustin Pop's avatar
Iustin Pop committed
667
668
669
670
671
    nv = val
  return nv


def IsValidIP(ip):
672
  """Verifies the syntax of an IPv4 address.
Iustin Pop's avatar
Iustin Pop committed
673

674
675
676
677
678
679
  This function checks if the IPv4 address passes is valid or not based
  on syntax (not IP range, class calculations, etc.).

  @type ip: str
  @param ip: the address to be checked
  @rtype: a regular expression match object
Michael Hanselmann's avatar
Michael Hanselmann committed
680
  @return: a regular expression match object, or None if the
681
      address is not valid
Iustin Pop's avatar
Iustin Pop committed
682
683
684

  """
  unit = "(0|[1-9]\d{0,2})"
685
  #TODO: convert and return only boolean
Iustin Pop's avatar
Iustin Pop committed
686
687
688
689
690
691
692
693
694
695
696
697
698
  return re.match("^%s\.%s\.%s\.%s$" % (unit, unit, unit, unit), ip)


def IsValidShellParam(word):
  """Verifies is the given word is safe from the shell's p.o.v.

  This means that we can pass this to a command via the shell and be
  sure that it doesn't alter the command line and is passed as such to
  the actual command.

  Note that we are overly restrictive here, in order to be on the safe
  side.

699
700
701
702
703
  @type word: str
  @param word: the word to check
  @rtype: boolean
  @return: True if the word is 'safe'

Iustin Pop's avatar
Iustin Pop committed
704
705
706
707
708
709
710
711
712
  """
  return bool(re.match("^[-a-zA-Z0-9._+/:%@]+$", word))


def BuildShellCmd(template, *args):
  """Build a safe shell command line from the given arguments.

  This function will check all arguments in the args list so that they
  are valid shell parameters (i.e. they don't contain shell
Michael Hanselmann's avatar
Michael Hanselmann committed
713
  metacharacters). If everything is ok, it will return the result of
Iustin Pop's avatar
Iustin Pop committed
714
715
  template % args.

716
717
718
719
720
721
  @type template: str
  @param template: the string holding the template for the
      string formatting
  @rtype: str
  @return: the expanded command line

Iustin Pop's avatar
Iustin Pop committed
722
723
724
  """
  for word in args:
    if not IsValidShellParam(word):
725
726
      raise errors.ProgrammerError("Shell argument '%s' contains"
                                   " invalid characters" % word)
Iustin Pop's avatar
Iustin Pop committed
727
728
729
  return template % args


730
def FormatUnit(value, units):
Iustin Pop's avatar
Iustin Pop committed
731
732
  """Formats an incoming number of MiB with the appropriate unit.

733
734
  @type value: int
  @param value: integer representing the value in MiB (1048576)
735
736
737
738
739
740
  @type units: char
  @param units: the type of formatting we should do:
      - 'h' for automatic scaling
      - 'm' for MiBs
      - 'g' for GiBs
      - 't' for TiBs
741
742
  @rtype: str
  @return: the formatted value (with suffix)
Iustin Pop's avatar
Iustin Pop committed
743
744

  """
745
746
  if units not in ('m', 'g', 't', 'h'):
    raise errors.ProgrammerError("Invalid unit specified '%s'" % str(units))
Iustin Pop's avatar
Iustin Pop committed
747

748
749
750
751
752
753
754
755
756
757
758
  suffix = ''

  if units == 'm' or (units == 'h' and value < 1024):
    if units == 'h':
      suffix = 'M'
    return "%d%s" % (round(value, 0), suffix)

  elif units == 'g' or (units == 'h' and value < (1024 * 1024)):
    if units == 'h':
      suffix = 'G'
    return "%0.1f%s" % (round(float(value) / 1024, 1), suffix)
Iustin Pop's avatar
Iustin Pop committed
759
760

  else:
761
762
763
    if units == 'h':
      suffix = 'T'
    return "%0.1f%s" % (round(float(value) / 1024 / 1024, 1), suffix)
Iustin Pop's avatar
Iustin Pop committed
764
765
766
767
768


def ParseUnit(input_string):
  """Tries to extract number and scale from the given string.

769
770
771
  Input must be in the format C{NUMBER+ [DOT NUMBER+] SPACE*
  [UNIT]}. If no unit is specified, it defaults to MiB. Return value
  is always an int in MiB.
Iustin Pop's avatar
Iustin Pop committed
772
773

  """
774
  m = re.match('^([.\d]+)\s*([a-zA-Z]+)?$', str(input_string))
Iustin Pop's avatar
Iustin Pop committed
775
  if not m:
776
    raise errors.UnitParseError("Invalid format")
Iustin Pop's avatar
Iustin Pop committed
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796

  value = float(m.groups()[0])

  unit = m.groups()[1]
  if unit:
    lcunit = unit.lower()
  else:
    lcunit = 'm'

  if lcunit in ('m', 'mb', 'mib'):
    # Value already in MiB
    pass

  elif lcunit in ('g', 'gb', 'gib'):
    value *= 1024

  elif lcunit in ('t', 'tb', 'tib'):
    value *= 1024 * 1024

  else:
797
    raise errors.UnitParseError("Unknown unit: %s" % unit)
Iustin Pop's avatar
Iustin Pop committed
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813

  # Make sure we round up
  if int(value) < value:
    value += 1

  # Round up to the next multiple of 4
  value = int(value)
  if value % 4:
    value += 4 - value % 4

  return value


def AddAuthorizedKey(file_name, key):
  """Adds an SSH public key to an authorized_keys file.

814
815
816
817
818
  @type file_name: str
  @param file_name: path to authorized_keys file
  @type key: str
  @param key: string containing key

Iustin Pop's avatar
Iustin Pop committed
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
  """
  key_fields = key.split()

  f = open(file_name, 'a+')
  try:
    nl = True
    for line in f:
      # Ignore whitespace changes
      if line.split() == key_fields:
        break
      nl = line.endswith('\n')
    else:
      if not nl:
        f.write("\n")
      f.write(key.rstrip('\r\n'))
      f.write("\n")
      f.flush()
  finally:
    f.close()


def RemoveAuthorizedKey(file_name, key):
  """Removes an SSH public key from an authorized_keys file.

843
844
845
846
847
  @type file_name: str
  @param file_name: path to authorized_keys file
  @type key: str
  @param key: string containing key

Iustin Pop's avatar
Iustin Pop committed
848
849
850
851
852
  """
  key_fields = key.split()

  fd, tmpname = tempfile.mkstemp(dir=os.path.dirname(file_name))
  try:
853
    out = os.fdopen(fd, 'w')
Iustin Pop's avatar
Iustin Pop committed
854
    try:
855
856
857
858
859
860
      f = open(file_name, 'r')
      try:
        for line in f:
          # Ignore whitespace changes while comparing lines
          if line.split() != key_fields:
            out.write(line)
861
862
863
864
865
866
867
868
869
870
871
872

        out.flush()
        os.rename(tmpname, file_name)
      finally:
        f.close()
    finally:
      out.close()
  except:
    RemoveFile(tmpname)
    raise


873
874
def SetEtcHostsEntry(file_name, ip, hostname, aliases):
  """Sets the name of an IP address and hostname in /etc/hosts.
875

876
877
878
879
880
881
882
883
884
  @type file_name: str
  @param file_name: path to the file to modify (usually C{/etc/hosts})
  @type ip: str
  @param ip: the IP address
  @type hostname: str
  @param hostname: the hostname to be added
  @type aliases: list
  @param aliases: the list of aliases to add for the hostname

885
  """
886
  # FIXME: use WriteFile + fn rather than duplicating its efforts
887
888
889
  # Ensure aliases are unique
  aliases = UniqueSequence([hostname] + aliases)[1:]

890
  fd, tmpname = tempfile.mkstemp(dir=os.path.dirname(file_name))
891
  try:
892
893
894
895
896
897
    out = os.fdopen(fd, 'w')
    try:
      f = open(file_name, 'r')
      try:
        for line in f:
          fields = line.split()
898
          if fields and not fields[0].startswith('#') and ip == fields[0]:
899
900
901
            continue
          out.write(line)

902
        out.write("%s\t%s" % (ip, hostname))
903
904
905
906
907
        if aliases:
          out.write(" %s" % ' '.join(aliases))
        out.write('\n')

        out.flush()
908
        os.fsync(out)
909
        os.chmod(tmpname, 0644)
910
911
912
913
914
915
916
917
        os.rename(tmpname, file_name)
      finally:
        f.close()
    finally:
      out.close()
  except:
    RemoveFile(tmpname)
    raise
918
919


920
921
922
def AddHostToEtcHosts(hostname):
  """Wrapper around SetEtcHostsEntry.

923
924
925
926
  @type hostname: str
  @param hostname: a hostname that will be resolved and added to
      L{constants.ETC_HOSTS}

927
928
929
930
931
  """
  hi = HostInfo(name=hostname)
  SetEtcHostsEntry(constants.ETC_HOSTS, hi.ip, hi.name, [hi.ShortName()])


932
def RemoveEtcHostsEntry(file_name, hostname):
933
  """Removes a hostname from /etc/hosts.
934

935
  IP addresses without names are removed from the file.
936
937
938
939
940
941

  @type file_name: str
  @param file_name: path to the file to modify (usually C{/etc/hosts})
  @type hostname: str
  @param hostname: the hostname to be removed

942
  """
943
  # FIXME: use WriteFile + fn rather than duplicating its efforts
944
945
946
947
948
949
950
951
952
953
954
955
956
957
  fd, tmpname = tempfile.mkstemp(dir=os.path.dirname(file_name))
  try:
    out = os.fdopen(fd, 'w')
    try:
      f = open(file_name, 'r')
      try:
        for line in f:
          fields = line.split()
          if len(fields) > 1 and not fields[0].startswith('#'):
            names = fields[1:]
            if hostname in names:
              while hostname in names:
                names.remove(hostname)
              if names:
958
                out.write("%s %s\n" % (fields[0], ' '.join(names)))
959
960
961
              continue

          out.write(line)
962
963

        out.flush()
964
        os.fsync(out)
965
        os.chmod(tmpname, 0644)
966
967
968
        os.rename(tmpname, file_name)
      finally:
        f.close()
Iustin Pop's avatar
Iustin Pop committed
969
    finally:
970
971
972
973
      out.close()
  except:
    RemoveFile(tmpname)
    raise
Iustin Pop's avatar
Iustin Pop committed
974
975


976
977
978
def RemoveHostFromEtcHosts(hostname):
  """Wrapper around RemoveEtcHostsEntry.

979
980
981
982
983
  @type hostname: str
  @param hostname: hostname that will be resolved and its
      full and shot name will be removed from
      L{constants.ETC_HOSTS}

984
985
986
987
988
989
  """
  hi = HostInfo(name=hostname)
  RemoveEtcHostsEntry(constants.ETC_HOSTS, hi.name)
  RemoveEtcHostsEntry(constants.ETC_HOSTS, hi.ShortName())


Iustin Pop's avatar
Iustin Pop committed
990
991
992
def CreateBackup(file_name):
  """Creates a backup of a file.

993
994
995
996
997
  @type file_name: str
  @param file_name: file to be backed up
  @rtype: str
  @return: the path to the newly created backup
  @raise errors.ProgrammerError: for invalid file names
Iustin Pop's avatar
Iustin Pop committed
998
999
1000

  """
  if not os.path.isfile(file_name):
1001
1002
    raise errors.ProgrammerError("Can't make a backup of a non-file '%s'" %
                                file_name)
Iustin Pop's avatar
Iustin Pop committed
1003

1004
  prefix = '%s.backup-%d.' % (os.path.basename(file_name), int(time.time()))
Iustin Pop's avatar
Iustin Pop committed
1005
  dir_name = os.path.dirname(file_name)
1006
1007
1008

  fsrc = open(file_name, 'rb')
  try:
Iustin Pop's avatar
Iustin Pop committed
1009
    (fd, backup_name) = tempfile.mkstemp(prefix=prefix, dir=dir_name)
1010
1011
1012
1013
1014
1015
1016
1017
    fdst = os.fdopen(fd, 'wb')
    try:
      shutil.copyfileobj(fsrc, fdst)
    finally:
      fdst.close()
  finally:
    fsrc.close()

Iustin Pop's avatar
Iustin Pop committed
1018
1019
1020
1021
1022
  return backup_name


def ShellQuote(value):
  """Quotes shell argument according to POSIX.
1023

1024
1025
1026
1027
1028
  @type value: str
  @param value: the argument to be quoted
  @rtype: str
  @return: the quoted value

Iustin Pop's avatar
Iustin Pop committed
1029
1030
1031
1032
1033
1034
1035
1036
  """
  if _re_shell_unquoted.match(value):
    return value
  else:
    return "'%s'" % value.replace("'", "'\\''")


def ShellQuoteArgs(args):
1037
1038
1039
1040
1041
  """Quotes a list of shell arguments.

  @type args: list
  @param args: list of arguments to be quoted
  @rtype: str
Michael Hanselmann's avatar
Michael Hanselmann committed
1042
  @return: the quoted arguments concatenated with spaces
Iustin Pop's avatar
Iustin Pop committed
1043
1044
1045

  """
  return ' '.join([ShellQuote(i) for i in args])
1046
1047


1048
def TcpPing(target, port, timeout=10, live_port_needed=False, source=None):
1049
1050
  """Simple ping implementation using TCP connect(2).

1051
1052
1053
1054
1055
1056
1057
1058
  Check if the given IP is reachable by doing attempting a TCP connect
  to it.

  @type target: str
  @param target: the IP or hostname to ping
  @type port: int
  @param port: the port to connect to
  @type timeout: int
Michael Hanselmann's avatar
Michael Hanselmann committed
1059
  @param timeout: the timeout on the connection attempt
1060
1061
1062
1063
1064
1065
1066
  @type live_port_needed: boolean
  @param live_port_needed: whether a closed port will cause the
      function to return failure, as if there was a timeout
  @type source: str or None
  @param source: if specified, will cause the connect to be made
      from this specific source address; failures to bind other
      than C{EADDRNOTAVAIL} will be ignored
1067
1068
1069
1070

  """
  sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)

1071
  success = False
1072

1073
1074
1075
  if source is not None:
    try:
      sock.bind((source, 0))
Michael Hanselmann's avatar
Michael Hanselmann committed
1076
    except socket.error, (errcode, _):
1077
1078
      if errcode == errno.EADDRNOTAVAIL:
        success = False
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088

  sock.settimeout(timeout)

  try:
    sock.connect((target, port))
    sock.close()
    success = True
  except socket.timeout:
    success = False
  except socket.error, (errcode, errstring):
1089
    success = (not live_port_needed) and (errcode == errno.ECONNREFUSED)
1090
1091

  return success
1092
1093


1094
1095
1096
def OwnIpAddress(address):
  """Check if the current host has the the given IP address.

1097
  Currently this is done by TCP-pinging the address from the loopback
1098
1099
1100
  address.

  @type address: string
Michael Hanselmann's avatar
Michael Hanselmann committed
1101
  @param address: the address to check
1102
  @rtype: bool
1103
  @return: True if we own the address
1104
1105
1106
1107
1108
1109

  """
  return TcpPing(address, constants.DEFAULT_NODED_PORT,
                 source=constants.LOCALHOST_IP_ADDRESS)


1110
def ListVisibleFiles(path):
1111
1112
1113
1114
1115
1116
  """Returns a list of visible files in a directory.

  @type path: str
  @param path: the directory to enumerate
  @rtype: list
  @return: the list of all files not starting with a dot
1117
1118

  """
1119
1120
1121
  files = [i for i in os.listdir(path) if not i.startswith(".")]
  files.sort()
  return files
1122
1123


1124
1125
1126
1127
1128
1129
def GetHomeDir(user, default=None):
  """Try to get the homedir of the given user.

  The user can be passed either as a string (denoting the name) or as
  an integer (denoting the user id). If the user is not found, the
  'default' argument is returned, which defaults to None.
1130
1131
1132

  """
  try:
1133
1134
1135
1136
1137
1138
1139
    if isinstance(user, basestring):
      result = pwd.getpwnam(user)
    elif isinstance(user, (int, long)):
      result = pwd.getpwuid(user)
    else:
      raise errors.ProgrammerError("Invalid type passed to GetHomeDir (%s)" %
                                   type(user))
1140
1141
1142
  except KeyError:
    return default
  return result.pw_dir
1143
1144


1145
def NewUUID():
1146
1147
  """Returns a random UUID.

1148
1149
1150
1151
  @note: This is a Linux-specific method as it uses the /proc
      filesystem.
  @rtype: str

1152
1153
1154
1155
1156
1157
  """
  f = open("/proc/sys/kernel/random/uuid", "r")
  try:
    return f.read(128).rstrip("\n")
  finally:
    f.close()
Iustin Pop's avatar
Iustin Pop committed
1158
1159


1160
1161
1162
1163
1164
1165
def GenerateSecret():
  """Generates a random secret.

  This will generate a pseudo-random secret, and return its sha digest
  (so that it can be used where an ASCII string is needed).

1166
1167
1168
  @rtype: str
  @return: a sha1 hexdigest of a block of 64 random bytes

1169
  """
1170
  return sha1(os.urandom(64)).hexdigest()
1171
1172


1173
1174
1175
1176
1177
1178
1179
1180
1181
def EnsureDirs(dirs):
  """Make required directories, if they don't exist.

  @param dirs: list of tuples (dir_name, dir_mode)
  @type dirs: list of (string, integer)

  """
  for dir_name, dir_mode in dirs:
    try:
Iustin Pop's avatar
Iustin Pop committed
1182
      os.mkdir(dir_name, dir_mode)
1183
1184
1185
    except EnvironmentError, err:
      if err.errno != errno.EEXIST:
        raise errors.GenericError("Cannot create needed directory"
Iustin Pop's avatar
Iustin Pop committed
1186
                                  " '%s': %s" % (dir_name, err))
1187
1188
1189
1190
    if not os.path.isdir(dir_name):
      raise errors.GenericError("%s is not a directory" % dir_name)


1191
1192
1193
1194
1195
def ReadFile(file_name, size=None):
  """Reads a file.

  @type size: None or int
  @param size: Read at most size bytes
1196
  @rtype: str
Michael Hanselmann's avatar
Michael Hanselmann committed
1197
  @return: the (possibly partial) content of the file
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209

  """
  f = open(file_name, "r")
  try:
    if size is None:
      return f.read()
    else:
      return f.read(size)
  finally:
    f.close()


Iustin Pop's avatar
Iustin Pop committed
1210
1211
def WriteFile(file_name, fn=None, data=None,
              mode=None, uid=-1, gid=-1,
1212
              atime=None, mtime=None, close=True,
1213
              dry_run=False, backup=False,
1214
              prewrite=None, postwrite=None):
Iustin Pop's avatar
Iustin Pop committed
1215
1216
1217
1218
1219
1220
1221
1222
1223
  """(Over)write a file atomically.

  The file_name and either fn (a function taking one argument, the
  file descriptor, and which should write the data to it) or data (the
  contents of the file) must be passed. The other arguments are
  optional and allow setting the file mode, owner and group, and the
  mtime/atime of the file.

  If the function doesn't raise an exception, it has succeeded and the
1224
  target file has the new contents. If the function has raised an
Iustin Pop's avatar
Iustin Pop committed
1225
1226
1227
  exception, an existing target file should be unmodified and the
  temporary file should be removed.

1228
1229
1230
1231
1232
  @type file_name: str
  @param file_name: the target filename
  @type fn: callable
  @param fn: content writing function, called with
      file descriptor as parameter
1233
  @type data: str
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
  @param data: contents of the file
  @type mode: int
  @param mode: file mode
  @type uid: int
  @param uid: the owner of the file
  @type gid: int
  @param gid: the group of the file
  @type atime: int
  @param atime: a custom access time to be set on the file
  @type mtime: int
  @param mtime: a custom modification time to be set on the file
  @type close: boolean
  @param close: whether to close file after writing it
  @type prewrite: callable
  @param prewrite: function to be called before writing content
  @type postwrite: callable
  @param postwrite: function to be called after writing content

  @rtype: None or int
  @return: None if the 'close' parameter evaluates to True,
      otherwise the file descriptor

1256
  @raise errors.ProgrammerError: if any of the arguments are not valid
1257

Iustin Pop's avatar
Iustin Pop committed
1258
  """
1259
  if not os.path.isabs(file_name):
Iustin Pop's avatar
Iustin Pop committed
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
    raise errors.ProgrammerError("Path passed to WriteFile is not"
                                 " absolute: '%s'" % file_name)

  if [fn, data].count(None) != 1:
    raise errors.ProgrammerError("fn or data required")

  if [atime, mtime].count(None) == 1:
    raise errors.ProgrammerError("Both atime and mtime must be either"
                                 " set or None")

Michael Hanselmann's avatar
Michael Hanselmann committed
1270
1271
  if backup and not dry_run and os.path.isfile(file_name):
    CreateBackup(file_name)
Iustin Pop's avatar
Iustin Pop committed
1272
1273
1274

  dir_name, base_name = os.path.split(file_name)
  fd, new_name = tempfile.mkstemp('.new', base_name, dir_name)
1275
  do_remove = True
Iustin Pop's avatar
Iustin Pop committed
1276
1277
1278
1279
1280
1281
1282
  # here we need to make sure we remove the temp file, if any error
  # leaves it in place
  try:
    if uid != -1 or gid != -1:
      os.chown(new_name, uid, gid)
    if mode:
      os.chmod(new_name, mode)
1283
1284
    if callable(prewrite):
      prewrite(fd)
Iustin Pop's avatar
Iustin Pop committed
1285
1286
1287
1288
    if data is not None:
      os.write(fd, data)
    else:
      fn(fd)
1289
1290
    if callable(postwrite):
      postwrite(fd)
Iustin Pop's avatar
Iustin Pop committed
1291
1292
1293
    os.fsync(fd)
    if atime is not None and mtime is not None:
      os.utime(new_name, (atime, mtime))
Michael Hanselmann's avatar
Michael Hanselmann committed
1294
1295
    if not dry_run:
      os.rename(new_name, file_name)
1296
      do_remove = False
Iustin Pop's avatar
Iustin Pop committed
1297
  finally:
1298
1299
1300
1301
1302
    if close:
      os.close(fd)
      result = None
    else:
      result = fd
1303
1304
    if do_remove:
      RemoveFile(new_name)
Guido Trotter's avatar
Guido Trotter committed
1305

1306
1307
  return result

Guido Trotter's avatar
Guido Trotter committed
1308

1309
1310
1311
1312
1313
1314
1315
1316
def FirstFree(seq, base=0):
  """Returns the first non-existing integer from seq.

  The seq argument should be a sorted list of positive integers. The
  first time the index of an element is smaller than the element
  value, the index will be returned.

  The base argument is used to start at a different offset,
1317
1318
1319
  i.e. C{[3, 4, 6]} with I{offset=3} will return 5.

  Example: C{[0, 1, 3]} will return I{2}.
1320

1321
1322
1323
1324
1325
1326
  @type seq: sequence
  @param seq: the sequence to be analyzed.
  @type base: int
  @param base: use this value as the base index of the sequence
  @rtype: int
  @return: the first non-used index in the sequence
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336

  """
  for idx, elem in enumerate(seq):
    assert elem >= base, "Passed element is higher than base offset"
    if elem > idx + base:
      # idx is not used
      return idx + base
  return None


Guido Trotter's avatar
Guido Trotter committed
1337
1338
def all(seq, pred=bool):
  "Returns True if pred(x) is True for every element in the iterable"
Michael Hanselmann's avatar
Michael Hanselmann committed
1339
  for _ in itertools.ifilterfalse(pred, seq):
Guido Trotter's avatar
Guido Trotter committed
1340
1341
1342
1343
1344
1345
    return False
  return True


def any(seq, pred=bool):
  "Returns True if pred(x) is True for at least one element in the iterable"
Michael Hanselmann's avatar
Michael Hanselmann committed
1346
  for _ in itertools.ifilter(pred, seq):
Guido Trotter's avatar
Guido Trotter committed
1347
1348
    return True
  return False
1349
1350
1351
1352
1353
1354


def UniqueSequence(seq):
  """Returns a list with unique elements.

  Element order is preserved.
1355
1356

  @type seq: sequence
Michael Hanselmann's avatar
Michael Hanselmann committed
1357
  @param seq: the sequence with the source elements
1358
1359
1360
  @rtype: list
  @return: list of unique elements from seq

1361
1362
1363
  """
  seen = set()