posix: move server side of unix domain sockets out of inotify

We also turn the unix domain socket into a class, so that we have a
sensible place to hang its logically related attributes and behaviour.

We'll shortly want to reuse this in other code.

hgext/inotify/linuxserver.py

@@ -1,444 +1,437
 # linuxserver.py - inotify status server for linux
 #
 # Copyright 2006, 2007, 2008 Bryan O'Sullivan <[e-mail]>
 # Copyright 2007, 2008 Brendan Cully <[e-mail]>
 #
 # This software may be used and distributed according to the terms of the
 # GNU General Public License version 2 or any later version.
 
 from mercurial.i18n import _
 from mercurial import osutil, util, error
 import server
 import errno, os, select, stat, sys, time
 
 try:
     import linux as inotify
     from linux import watcher
 except ImportError:
     raise
 
 def walkrepodirs(dirstate, absroot):
     '''Iterate over all subdirectories of this repo.
     Exclude the .hg directory, any nested repos, and ignored dirs.'''
     def walkit(dirname, top):
         fullpath = server.join(absroot, dirname)
         try:
             for name, kind in osutil.listdir(fullpath):
                 if kind == stat.S_IFDIR:
                     if name == '.hg':
                         if not top:
                             return
                     else:
                         d = server.join(dirname, name)
                         if dirstate._ignore(d):
                             continue
                         for subdir in walkit(d, False):
                             yield subdir
         except OSError, err:
             if err.errno not in server.walk_ignored_errors:
                 raise
         yield fullpath
 
     return walkit('', True)
 
 def _explain_watch_limit(ui, dirstate, rootabs):
     path = '/proc/sys/fs/inotify/max_user_watches'
     try:
         limit = int(util.readfile(path))
     except IOError, err:
         if err.errno != errno.ENOENT:
             raise
         raise util.Abort(_('this system does not seem to '
                            'support inotify'))
     ui.warn(_('*** the current per-user limit on the number '
               'of inotify watches is %s\n') % limit)
     ui.warn(_('*** this limit is too low to watch every '
               'directory in this repository\n'))
     ui.warn(_('*** counting directories: '))
     ndirs = len(list(walkrepodirs(dirstate, rootabs)))
     ui.warn(_('found %d\n') % ndirs)
     newlimit = min(limit, 1024)
     while newlimit < ((limit + ndirs) * 1.1):
         newlimit *= 2
     ui.warn(_('*** to raise the limit from %d to %d (run as root):\n') %
             (limit, newlimit))
     ui.warn(_('***  echo %d > %s\n') % (newlimit, path))
     raise util.Abort(_('cannot watch %s until inotify watch limit is raised')
                      % rootabs)
 
 class pollable(object):
     """
     Interface to support polling.
     The file descriptor returned by fileno() is registered to a polling
     object.
     Usage:
         Every tick, check if an event has happened since the last tick:
         * If yes, call handle_events
         * If no, call handle_timeout
     """
     poll_events = select.POLLIN
     instances = {}
     poll = select.poll()
 
     def fileno(self):
         raise NotImplementedError
 
     def handle_events(self, events):
         raise NotImplementedError
 
     def handle_timeout(self):
         raise NotImplementedError
 
     def shutdown(self):
         raise NotImplementedError
 
     def register(self, timeout):
         fd = self.fileno()
 
         pollable.poll.register(fd, pollable.poll_events)
         pollable.instances[fd] = self
 
         self.registered = True
         self.timeout = timeout
 
     def unregister(self):
         pollable.poll.unregister(self)
         self.registered = False
 
     @classmethod
     def run(cls):
         while True:
             timeout = None
             timeobj = None
             for obj in cls.instances.itervalues():
                 if obj.timeout is not None and (timeout is None
                                                 or obj.timeout < timeout):
                     timeout, timeobj = obj.timeout, obj
             try:
                 events = cls.poll.poll(timeout)
             except select.error, err:
                 if err.args[0] == errno.EINTR:
                     continue
                 raise
             if events:
                 by_fd = {}
                 for fd, event in events:
                     by_fd.setdefault(fd, []).append(event)
 
                 for fd, events in by_fd.iteritems():
                     cls.instances[fd].handle_pollevents(events)
 
             elif timeobj:
                 timeobj.handle_timeout()
 
 def eventaction(code):
     """
     Decorator to help handle events in repowatcher
     """
     def decorator(f):
         def wrapper(self, wpath):
             if code == 'm' and wpath in self.lastevent and \
                 self.lastevent[wpath] in 'cm':
                 return
             self.lastevent[wpath] = code
             self.timeout = 250
 
             f(self, wpath)
 
         wrapper.func_name = f.func_name
         return wrapper
     return decorator
 
 class repowatcher(server.repowatcher, pollable):
     """
     Watches inotify events
     """
     mask = (
         inotify.IN_ATTRIB |
         inotify.IN_CREATE |
         inotify.IN_DELETE |
         inotify.IN_DELETE_SELF |
         inotify.IN_MODIFY |
         inotify.IN_MOVED_FROM |
         inotify.IN_MOVED_TO |
         inotify.IN_MOVE_SELF |
         inotify.IN_ONLYDIR |
         inotify.IN_UNMOUNT |
         0)
 
     def __init__(self, ui, dirstate, root):
         server.repowatcher.__init__(self, ui, dirstate, root)
 
         self.lastevent = {}
         self.dirty = False
         try:
             self.watcher = watcher.watcher()
         except OSError, err:
             raise util.Abort(_('inotify service not available: %s') %
                              err.strerror)
         self.threshold = watcher.threshold(self.watcher)
         self.fileno = self.watcher.fileno
         self.register(timeout=None)
 
         self.handle_timeout()
         self.scan()
 
     def event_time(self):
         last = self.last_event
         now = time.time()
         self.last_event = now
 
         if last is None:
             return 'start'
         delta = now - last
         if delta < 5:
             return '+%.3f' % delta
         if delta < 50:
             return '+%.2f' % delta
         return '+%.1f' % delta
 
     def add_watch(self, path, mask):
         if not path:
             return
         if self.watcher.path(path) is None:
             if self.ui.debugflag:
                 self.ui.note(_('watching %r\n') % path[self.prefixlen:])
             try:
                 self.watcher.add(path, mask)
             except OSError, err:
                 if err.errno in (errno.ENOENT, errno.ENOTDIR):
                     return
                 if err.errno != errno.ENOSPC:
                     raise
                 _explain_watch_limit(self.ui, self.dirstate, self.wprefix)
 
     def setup(self):
         self.ui.note(_('watching directories under %r\n') % self.wprefix)
         self.add_watch(self.wprefix + '.hg', inotify.IN_DELETE)
 
     def scan(self, topdir=''):
         ds = self.dirstate._map.copy()
         self.add_watch(server.join(self.wprefix, topdir), self.mask)
         for root, dirs, files in server.walk(self.dirstate, self.wprefix,
                                              topdir):
             for d in dirs:
                 self.add_watch(server.join(root, d), self.mask)
             wroot = root[self.prefixlen:]
             for fn in files:
                 wfn = server.join(wroot, fn)
                 self.updatefile(wfn, self.getstat(wfn))
                 ds.pop(wfn, None)
         wtopdir = topdir
         if wtopdir and wtopdir[-1] != '/':
             wtopdir += '/'
         for wfn, state in ds.iteritems():
             if not wfn.startswith(wtopdir):
                 continue
             try:
                 st = self.stat(wfn)
             except OSError:
                 status = state[0]
                 self.deletefile(wfn, status)
             else:
                 self.updatefile(wfn, st)
         self.check_deleted('!')
         self.check_deleted('r')
 
     @eventaction('c')
     def created(self, wpath):
         if wpath == '.hgignore':
             self.update_hgignore()
         try:
             st = self.stat(wpath)
             if stat.S_ISREG(st[0]) or stat.S_ISLNK(st[0]):
                 self.updatefile(wpath, st)
         except OSError:
             pass
 
     @eventaction('m')
     def modified(self, wpath):
         if wpath == '.hgignore':
             self.update_hgignore()
         try:
             st = self.stat(wpath)
             if stat.S_ISREG(st[0]):
                 if self.dirstate[wpath] in 'lmn':
                     self.updatefile(wpath, st)
         except OSError:
             pass
 
     @eventaction('d')
     def deleted(self, wpath):
         if wpath == '.hgignore':
             self.update_hgignore()
         elif wpath.startswith('.hg/'):
             return
 
         self.deletefile(wpath, self.dirstate[wpath])
 
     def process_create(self, wpath, evt):
         if self.ui.debugflag:
             self.ui.note(_('%s event: created %s\n') %
                          (self.event_time(), wpath))
 
         if evt.mask & inotify.IN_ISDIR:
             self.scan(wpath)
         else:
             self.created(wpath)
 
     def process_delete(self, wpath, evt):
         if self.ui.debugflag:
             self.ui.note(_('%s event: deleted %s\n') %
                          (self.event_time(), wpath))
 
         if evt.mask & inotify.IN_ISDIR:
             tree = self.tree.dir(wpath)
             todelete = [wfn for wfn, ignore in tree.walk('?')]
             for fn in todelete:
                 self.deletefile(fn, '?')
             self.scan(wpath)
         else:
             self.deleted(wpath)
 
     def process_modify(self, wpath, evt):
         if self.ui.debugflag:
             self.ui.note(_('%s event: modified %s\n') %
                          (self.event_time(), wpath))
 
         if not (evt.mask & inotify.IN_ISDIR):
             self.modified(wpath)
 
     def process_unmount(self, evt):
         self.ui.warn(_('filesystem containing %s was unmounted\n') %
                      evt.fullpath)
         sys.exit(0)
 
     def handle_pollevents(self, events):
         if self.ui.debugflag:
             self.ui.note(_('%s readable: %d bytes\n') %
                          (self.event_time(), self.threshold.readable()))
         if not self.threshold():
             if self.registered:
                 if self.ui.debugflag:
                     self.ui.note(_('%s below threshold - unhooking\n') %
                                  (self.event_time()))
                 self.unregister()
                 self.timeout = 250
         else:
             self.read_events()
 
     def read_events(self, bufsize=None):
         events = self.watcher.read(bufsize)
         if self.ui.debugflag:
             self.ui.note(_('%s reading %d events\n') %
                          (self.event_time(), len(events)))
         for evt in events:
             if evt.fullpath == self.wprefix[:-1]:
                 # events on the root of the repository
                 # itself, e.g. permission changes or repository move
                 continue
             assert evt.fullpath.startswith(self.wprefix)
             wpath = evt.fullpath[self.prefixlen:]
 
             # paths have been normalized, wpath never ends with a '/'
 
             if wpath.startswith('.hg/') and evt.mask & inotify.IN_ISDIR:
                 # ignore subdirectories of .hg/ (merge, patches...)
                 continue
             if wpath == ".hg/wlock":
                 if evt.mask & inotify.IN_DELETE:
                     self.dirstate.invalidate()
                     self.dirty = False
                     self.scan()
                 elif evt.mask & inotify.IN_CREATE:
                     self.dirty = True
             else:
                 if self.dirty:
                     continue
 
                 if evt.mask & inotify.IN_UNMOUNT:
                     self.process_unmount(wpath, evt)
                 elif evt.mask & (inotify.IN_MODIFY | inotify.IN_ATTRIB):
                     self.process_modify(wpath, evt)
                 elif evt.mask & (inotify.IN_DELETE | inotify.IN_DELETE_SELF |
                                  inotify.IN_MOVED_FROM):
                     self.process_delete(wpath, evt)
                 elif evt.mask & (inotify.IN_CREATE | inotify.IN_MOVED_TO):
                     self.process_create(wpath, evt)
 
         self.lastevent.clear()
 
     def handle_timeout(self):
         if not self.registered:
             if self.ui.debugflag:
                 self.ui.note(_('%s hooking back up with %d bytes readable\n') %
                              (self.event_time(), self.threshold.readable()))
             self.read_events(0)
             self.register(timeout=None)
 
         self.timeout = None
 
     def shutdown(self):
         self.watcher.close()
 
     def debug(self):
         """
         Returns a sorted list of relatives paths currently watched,
         for debugging purposes.
         """
         return sorted(tuple[0][self.prefixlen:] for tuple in self.watcher)
 
 class socketlistener(server.socketlistener, pollable):
     """
     Listens for client queries on unix socket inotify.sock
     """
     def __init__(self, ui, root, repowatcher, timeout):
         server.socketlistener.__init__(self, ui, root, repowatcher, timeout)
         self.register(timeout=timeout)
 
     def handle_timeout(self):
         raise server.TimeoutException
 
     def handle_pollevents(self, events):
         for e in events:
             self.accept_connection()
 
     def shutdown(self):
         self.sock.close()
-        try:
-            os.unlink(self.sockpath)
-            if self.realsockpath:
-                os.unlink(self.realsockpath)
-                os.rmdir(os.path.dirname(self.realsockpath))
-        except OSError, err:
-            if err.errno != errno.ENOENT:
-                raise
+        self.sock.cleanup()
 
     def answer_stat_query(self, cs):
         if self.repowatcher.timeout:
             # We got a query while a rescan is pending.  Make sure we
             # rescan before responding, or we could give back a wrong
             # answer.
             self.repowatcher.handle_timeout()
         return server.socketlistener.answer_stat_query(self, cs)
 
 class master(object):
     def __init__(self, ui, dirstate, root, timeout=None):
         self.ui = ui
         self.repowatcher = repowatcher(ui, dirstate, root)
         self.socketlistener = socketlistener(ui, root, self.repowatcher,
                                              timeout)
 
     def shutdown(self):
         for obj in pollable.instances.itervalues():
             try:
                 obj.shutdown()
             except error.SignalInterrupt:
                 pass
 
     def run(self):
         self.repowatcher.setup()
         self.ui.note(_('finished setup\n'))
         if os.getenv('TIME_STARTUP'):
             sys.exit(0)
         pollable.run()

hgext/inotify/server.py

@@ -1,491 +1,465
 # server.py - common entry point for inotify status server
 #
 # Copyright 2009 Nicolas Dumazet <[e-mail]>
 #
 # This software may be used and distributed according to the terms of the
 # GNU General Public License version 2 or any later version.
 
 from mercurial.i18n import _
-from mercurial import cmdutil, osutil, util
+from mercurial import cmdutil, posix, osutil, util
 import common
 
 import errno
 import os
 import socket
 import stat
 import struct
 import sys
 import tempfile
 
 class AlreadyStartedException(Exception):
     pass
 class TimeoutException(Exception):
     pass
 
 def join(a, b):
     if a:
         if a[-1] == '/':
             return a + b
         return a + '/' + b
     return b
 
 def split(path):
     c = path.rfind('/')
     if c == -1:
         return '', path
     return path[:c], path[c + 1:]
 
 walk_ignored_errors = (errno.ENOENT, errno.ENAMETOOLONG)
 
 def walk(dirstate, absroot, root):
     '''Like os.walk, but only yields regular files.'''
 
     # This function is critical to performance during startup.
 
     def walkit(root, reporoot):
         files, dirs = [], []
 
         try:
             fullpath = join(absroot, root)
             for name, kind in osutil.listdir(fullpath):
                 if kind == stat.S_IFDIR:
                     if name == '.hg':
                         if not reporoot:
                             return
                     else:
                         dirs.append(name)
                         path = join(root, name)
                         if dirstate._ignore(path):
                             continue
                         for result in walkit(path, False):
                             yield result
                 elif kind in (stat.S_IFREG, stat.S_IFLNK):
                     files.append(name)
             yield fullpath, dirs, files
 
         except OSError, err:
             if err.errno == errno.ENOTDIR:
                 # fullpath was a directory, but has since been replaced
                 # by a file.
                 yield fullpath, dirs, files
             elif err.errno not in walk_ignored_errors:
                 raise
 
     return walkit(root, root == '')
 
 class directory(object):
     """
     Representing a directory
 
     * path is the relative path from repo root to this directory
     * files is a dict listing the files in this directory
         - keys are file names
         - values are file status
     * dirs is a dict listing the subdirectories
         - key are subdirectories names
         - values are directory objects
     """
     def __init__(self, relpath=''):
         self.path = relpath
         self.files = {}
         self.dirs = {}
 
     def dir(self, relpath):
         """
         Returns the directory contained at the relative path relpath.
         Creates the intermediate directories if necessary.
         """
         if not relpath:
             return self
         l = relpath.split('/')
         ret = self
         while l:
             next = l.pop(0)
             try:
                 ret = ret.dirs[next]
             except KeyError:
                 d = directory(join(ret.path, next))
                 ret.dirs[next] = d
                 ret = d
         return ret
 
     def walk(self, states, visited=None):
         """
         yield (filename, status) pairs for items in the trees
         that have status in states.
         filenames are relative to the repo root
         """
         for file, st in self.files.iteritems():
             if st in states:
                 yield join(self.path, file), st
         for dir in self.dirs.itervalues():
             if visited is not None:
                 visited.add(dir.path)
             for e in dir.walk(states):
                 yield e
 
     def lookup(self, states, path, visited):
         """
         yield root-relative filenames that match path, and whose
         status are in states:
         * if path is a file, yield path
         * if path is a directory, yield directory files
         * if path is not tracked, yield nothing
         """
         if path[-1] == '/':
             path = path[:-1]
 
         paths = path.split('/')
 
         # we need to check separately for last node
         last = paths.pop()
 
         tree = self
         try:
             for dir in paths:
                 tree = tree.dirs[dir]
         except KeyError:
             # path is not tracked
             visited.add(tree.path)
             return
 
         try:
             # if path is a directory, walk it
             target = tree.dirs[last]
             visited.add(target.path)
             for file, st in target.walk(states, visited):
                 yield file
         except KeyError:
             try:
                 if tree.files[last] in states:
                     # path is a file
                     visited.add(tree.path)
                     yield path
             except KeyError:
                 # path is not tracked
                 pass
 
 class repowatcher(object):
     """
     Watches inotify events
     """
     statuskeys = 'almr!?'
 
     def __init__(self, ui, dirstate, root):
         self.ui = ui
         self.dirstate = dirstate
 
         self.wprefix = join(root, '')
         self.prefixlen = len(self.wprefix)
 
         self.tree = directory()
         self.statcache = {}
         self.statustrees = dict([(s, directory()) for s in self.statuskeys])
 
         self.ds_info = self.dirstate_info()
 
         self.last_event = None
 
 
     def handle_timeout(self):
         pass
 
     def dirstate_info(self):
         try:
             st = os.lstat(self.wprefix + '.hg/dirstate')
             return st.st_mtime, st.st_ino
         except OSError, err:
             if err.errno != errno.ENOENT:
                 raise
             return 0, 0
 
     def filestatus(self, fn, st):
         try:
             type_, mode, size, time = self.dirstate._map[fn][:4]
         except KeyError:
             type_ = '?'
         if type_ == 'n':
             st_mode, st_size, st_mtime = st
             if size == -1:
                 return 'l'
             if size and (size != st_size or (mode ^ st_mode) & 0100):
                 return 'm'
             if time != int(st_mtime):
                 return 'l'
             return 'n'
         if type_ == '?' and self.dirstate._dirignore(fn):
             # we must check not only if the file is ignored, but if any part
             # of its path match an ignore pattern
             return 'i'
         return type_
 
     def updatefile(self, wfn, osstat):
         '''
         update the file entry of an existing file.
 
         osstat: (mode, size, time) tuple, as returned by os.lstat(wfn)
         '''
 
         self._updatestatus(wfn, self.filestatus(wfn, osstat))
 
     def deletefile(self, wfn, oldstatus):
         '''
         update the entry of a file which has been deleted.
 
         oldstatus: char in statuskeys, status of the file before deletion
         '''
         if oldstatus == 'r':
             newstatus = 'r'
         elif oldstatus in 'almn':
             newstatus = '!'
         else:
             newstatus = None
 
         self.statcache.pop(wfn, None)
         self._updatestatus(wfn, newstatus)
 
     def _updatestatus(self, wfn, newstatus):
         '''
         Update the stored status of a file.
 
         newstatus: - char in (statuskeys + 'ni'), new status to apply.
                    - or None, to stop tracking wfn
         '''
         root, fn = split(wfn)
         d = self.tree.dir(root)
 
         oldstatus = d.files.get(fn)
         # oldstatus can be either:
         # - None : fn is new
         # - a char in statuskeys: fn is a (tracked) file
 
         if self.ui.debugflag and oldstatus != newstatus:
             self.ui.note(_('status: %r %s -> %s\n') %
                              (wfn, oldstatus, newstatus))
 
         if oldstatus and oldstatus in self.statuskeys \
             and oldstatus != newstatus:
             del self.statustrees[oldstatus].dir(root).files[fn]
 
         if newstatus in (None, 'i'):
             d.files.pop(fn, None)
         elif oldstatus != newstatus:
             d.files[fn] = newstatus
             if newstatus != 'n':
                 self.statustrees[newstatus].dir(root).files[fn] = newstatus
 
     def check_deleted(self, key):
         # Files that had been deleted but were present in the dirstate
         # may have vanished from the dirstate; we must clean them up.
         nuke = []
         for wfn, ignore in self.statustrees[key].walk(key):
             if wfn not in self.dirstate:
                 nuke.append(wfn)
         for wfn in nuke:
             root, fn = split(wfn)
             del self.statustrees[key].dir(root).files[fn]
             del self.tree.dir(root).files[fn]
 
     def update_hgignore(self):
         # An update of the ignore file can potentially change the
         # states of all unknown and ignored files.
 
         # XXX If the user has other ignore files outside the repo, or
         # changes their list of ignore files at run time, we'll
         # potentially never see changes to them.  We could get the
         # client to report to us what ignore data they're using.
         # But it's easier to do nothing than to open that can of
         # worms.
 
         if '_ignore' in self.dirstate.__dict__:
             delattr(self.dirstate, '_ignore')
             self.ui.note(_('rescanning due to .hgignore change\n'))
             self.handle_timeout()
             self.scan()
 
     def getstat(self, wpath):
         try:
             return self.statcache[wpath]
         except KeyError:
             try:
                 return self.stat(wpath)
             except OSError, err:
                 if err.errno != errno.ENOENT:
                     raise
 
     def stat(self, wpath):
         try:
             st = os.lstat(join(self.wprefix, wpath))
             ret = st.st_mode, st.st_size, st.st_mtime
             self.statcache[wpath] = ret
             return ret
         except OSError:
             self.statcache.pop(wpath, None)
             raise
 
 class socketlistener(object):
     """
     Listens for client queries on unix socket inotify.sock
     """
     def __init__(self, ui, root, repowatcher, timeout):
         self.ui = ui
         self.repowatcher = repowatcher
-        self.sock = socket.socket(socket.AF_UNIX)
-        self.sockpath = join(root, '.hg/inotify.sock')
-
-        self.realsockpath = self.sockpath
-        if os.path.islink(self.sockpath):
-            if os.path.exists(self.sockpath):
-                self.realsockpath = os.readlink(self.sockpath)
-            else:
-                os.unlink(self.sockpath)
         try:
-            self.sock.bind(self.realsockpath)
-        except socket.error, err:
-            if err.args[0] == errno.EADDRINUSE:
-                raise AlreadyStartedException(_('cannot start: socket is '
-                                                'already bound'))
-            if err.args[0] == "AF_UNIX path too long":
-                tempdir = tempfile.mkdtemp(prefix="hg-inotify-")
-                self.realsockpath = os.path.join(tempdir, "inotify.sock")
-                try:
-                    self.sock.bind(self.realsockpath)
-                    os.symlink(self.realsockpath, self.sockpath)
-                except (OSError, socket.error), inst:
-                    try:
-                        os.unlink(self.realsockpath)
-                    except OSError:
-                        pass
-                    os.rmdir(tempdir)
-                    if inst.errno == errno.EEXIST:
-                        raise AlreadyStartedException(_('cannot start: tried '
-                            'linking .hg/inotify.sock to a temporary socket but'
-                            ' .hg/inotify.sock already exists'))
-                    raise
-            else:
-                raise
-        self.sock.listen(5)
+            self.sock = posix.unixdomainserver(
+                lambda p: os.path.join(root, '.hg', p),
+                'inotify')
+        except (OSError, socket.error), err:
+            if err.errno == errno.EADDRINUSE:
+                raise AlreadyStartedException(_('cannot start: '
+                                                'socket is already bound'))
+            raise
         self.fileno = self.sock.fileno
 
     def answer_stat_query(self, cs):
         names = cs.read().split('\0')
 
         states = names.pop()
 
         self.ui.note(_('answering query for %r\n') % states)
 
         visited = set()
         if not names:
             def genresult(states, tree):
                 for fn, state in tree.walk(states):
                     yield fn
         else:
             def genresult(states, tree):
                 for fn in names:
                     for f in tree.lookup(states, fn, visited):
                         yield f
 
         return ['\0'.join(r) for r in [
             genresult('l', self.repowatcher.statustrees['l']),
             genresult('m', self.repowatcher.statustrees['m']),
             genresult('a', self.repowatcher.statustrees['a']),
             genresult('r', self.repowatcher.statustrees['r']),
             genresult('!', self.repowatcher.statustrees['!']),
             '?' in states
                 and genresult('?', self.repowatcher.statustrees['?'])
                 or [],
             [],
             'c' in states and genresult('n', self.repowatcher.tree) or [],
             visited
             ]]
 
     def answer_dbug_query(self):
         return ['\0'.join(self.repowatcher.debug())]
 
     def accept_connection(self):
         sock, addr = self.sock.accept()
 
         cs = common.recvcs(sock)
         version = ord(cs.read(1))
 
         if version != common.version:
             self.ui.warn(_('received query from incompatible client '
                            'version %d\n') % version)
             try:
                 # try to send back our version to the client
                 # this way, the client too is informed of the mismatch
                 sock.sendall(chr(common.version))
             except socket.error:
                 pass
             return
 
         type = cs.read(4)
 
         if type == 'STAT':
             results = self.answer_stat_query(cs)
         elif type == 'DBUG':
             results = self.answer_dbug_query()
         else:
             self.ui.warn(_('unrecognized query type: %s\n') % type)
             return
 
         try:
             try:
                 v = chr(common.version)
 
                 sock.sendall(v + type + struct.pack(common.resphdrfmts[type],
                                             *map(len, results)))
                 sock.sendall(''.join(results))
             finally:
                 sock.shutdown(socket.SHUT_WR)
         except socket.error, err:
             if err.args[0] != errno.EPIPE:
                 raise
 
 if sys.platform.startswith('linux'):
     import linuxserver as _server
 else:
     raise ImportError
 
 master = _server.master
 
 def start(ui, dirstate, root, opts):
     timeout = opts.get('idle_timeout')
     if timeout:
         timeout = float(timeout) * 60000
     else:
         timeout = None
 
     class service(object):
         def init(self):
             try:
                 self.master = master(ui, dirstate, root, timeout)
             except AlreadyStartedException, inst:
                 raise util.Abort("inotify-server: %s" % inst)
 
         def run(self):
             try:
                 try:
                     self.master.run()
                 except TimeoutException:
                     pass
             finally:
                 self.master.shutdown()
 
     if 'inserve' not in sys.argv:
         runargs = util.hgcmd() + ['inserve', '-R', root]
     else:
         runargs = util.hgcmd() + sys.argv[1:]
 
     pidfile = ui.config('inotify', 'pidfile')
     if opts['daemon'] and pidfile is not None and 'pid-file' not in runargs:
         runargs.append("--pid-file=%s" % pidfile)
 
     service = service()
     logfile = ui.config('inotify', 'log')
 
     appendpid = ui.configbool('inotify', 'appendpid', False)
 
     ui.debug('starting inotify server: %s\n' % ' '.join(runargs))
     cmdutil.service(opts, initfn=service.init, runfn=service.run,
                     logfile=logfile, runargs=runargs, appendpid=appendpid)

mercurial/posix.py

@@ -1,485 +1,525
 # posix.py - Posix utility function implementations for Mercurial
 #
 #  Copyright 2005-2009 Matt Mackall <[e-mail]> and others
 #
 # This software may be used and distributed according to the terms of the
 # GNU General Public License version 2 or any later version.
 
 from i18n import _
 import encoding
-import os, sys, errno, stat, getpass, pwd, grp, tempfile, unicodedata
+import os, sys, errno, stat, getpass, pwd, grp, socket, tempfile, unicodedata
 
 posixfile = open
 normpath = os.path.normpath
 samestat = os.path.samestat
 oslink = os.link
 unlink = os.unlink
 rename = os.rename
 expandglobs = False
 
 umask = os.umask(0)
 os.umask(umask)
 
 def split(p):
     '''Same as os.path.split, but faster'''
     ht = p.rsplit('/', 1)
     if len(ht) == 1:
         return '', p
     nh = ht[0].rstrip('/')
     if nh:
         return nh, ht[1]
     return ht
 
 def openhardlinks():
     '''return true if it is safe to hold open file handles to hardlinks'''
     return True
 
 def nlinks(name):
     '''return number of hardlinks for the given file'''
     return os.lstat(name).st_nlink
 
 def parsepatchoutput(output_line):
     """parses the output produced by patch and returns the filename"""
     pf = output_line[14:]
     if os.sys.platform == 'OpenVMS':
         if pf[0] == '`':
             pf = pf[1:-1] # Remove the quotes
     else:
         if pf.startswith("'") and pf.endswith("'") and " " in pf:
             pf = pf[1:-1] # Remove the quotes
     return pf
 
 def sshargs(sshcmd, host, user, port):
     '''Build argument list for ssh'''
     args = user and ("%s@%s" % (user, host)) or host
     return port and ("%s -p %s" % (args, port)) or args
 
 def isexec(f):
     """check whether a file is executable"""
     return (os.lstat(f).st_mode & 0100 != 0)
 
 def setflags(f, l, x):
     s = os.lstat(f).st_mode
     if l:
         if not stat.S_ISLNK(s):
             # switch file to link
             fp = open(f)
             data = fp.read()
             fp.close()
             os.unlink(f)
             try:
                 os.symlink(data, f)
             except OSError:
                 # failed to make a link, rewrite file
                 fp = open(f, "w")
                 fp.write(data)
                 fp.close()
         # no chmod needed at this point
         return
     if stat.S_ISLNK(s):
         # switch link to file
         data = os.readlink(f)
         os.unlink(f)
         fp = open(f, "w")
         fp.write(data)
         fp.close()
         s = 0666 & ~umask # avoid restatting for chmod
 
     sx = s & 0100
     if x and not sx:
         # Turn on +x for every +r bit when making a file executable
         # and obey umask.
         os.chmod(f, s | (s & 0444) >> 2 & ~umask)
     elif not x and sx:
         # Turn off all +x bits
         os.chmod(f, s & 0666)
 
 def copymode(src, dst, mode=None):
     '''Copy the file mode from the file at path src to dst.
     If src doesn't exist, we're using mode instead. If mode is None, we're
     using umask.'''
     try:
         st_mode = os.lstat(src).st_mode & 0777
     except OSError, inst:
         if inst.errno != errno.ENOENT:
             raise
         st_mode = mode
         if st_mode is None:
             st_mode = ~umask
         st_mode &= 0666
     os.chmod(dst, st_mode)
 
 def checkexec(path):
     """
     Check whether the given path is on a filesystem with UNIX-like exec flags
 
     Requires a directory (like /foo/.hg)
     """
 
     # VFAT on some Linux versions can flip mode but it doesn't persist
     # a FS remount. Frequently we can detect it if files are created
     # with exec bit on.
 
     try:
         EXECFLAGS = stat.S_IXUSR | stat.S_IXGRP | stat.S_IXOTH
         fh, fn = tempfile.mkstemp(dir=path, prefix='hg-checkexec-')
         try:
             os.close(fh)
             m = os.stat(fn).st_mode & 0777
             new_file_has_exec = m & EXECFLAGS
             os.chmod(fn, m ^ EXECFLAGS)
             exec_flags_cannot_flip = ((os.stat(fn).st_mode & 0777) == m)
         finally:
             os.unlink(fn)
     except (IOError, OSError):
         # we don't care, the user probably won't be able to commit anyway
         return False
     return not (new_file_has_exec or exec_flags_cannot_flip)
 
 def checklink(path):
     """check whether the given path is on a symlink-capable filesystem"""
     # mktemp is not racy because symlink creation will fail if the
     # file already exists
     name = tempfile.mktemp(dir=path, prefix='hg-checklink-')
     try:
         os.symlink(".", name)
         os.unlink(name)
         return True
     except (OSError, AttributeError):
         return False
 
 def checkosfilename(path):
     '''Check that the base-relative path is a valid filename on this platform.
     Returns None if the path is ok, or a UI string describing the problem.'''
     pass # on posix platforms, every path is ok
 
 def setbinary(fd):
     pass
 
 def pconvert(path):
     return path
 
 def localpath(path):
     return path
 
 def samefile(fpath1, fpath2):
     """Returns whether path1 and path2 refer to the same file. This is only
     guaranteed to work for files, not directories."""
     return os.path.samefile(fpath1, fpath2)
 
 def samedevice(fpath1, fpath2):
     """Returns whether fpath1 and fpath2 are on the same device. This is only
     guaranteed to work for files, not directories."""
     st1 = os.lstat(fpath1)
     st2 = os.lstat(fpath2)
     return st1.st_dev == st2.st_dev
 
 # os.path.normcase is a no-op, which doesn't help us on non-native filesystems
 def normcase(path):
     return path.lower()
 
 if sys.platform == 'darwin':
     import fcntl # only needed on darwin, missing on jython
 
     def normcase(path):
         try:
             u = path.decode('utf-8')
         except UnicodeDecodeError:
             # percent-encode any characters that don't round-trip
             p2 = path.decode('utf-8', 'ignore').encode('utf-8')
             s = ""
             pos = 0
             for c in path:
                 if p2[pos:pos + 1] == c:
                     s += c
                     pos += 1
                 else:
                     s += "%%%02X" % ord(c)
             u = s.decode('utf-8')
 
         # Decompose then lowercase (HFS+ technote specifies lower)
         return unicodedata.normalize('NFD', u).lower().encode('utf-8')
 
     def realpath(path):
         '''
         Returns the true, canonical file system path equivalent to the given
         path.
 
         Equivalent means, in this case, resulting in the same, unique
         file system link to the path. Every file system entry, whether a file,
         directory, hard link or symbolic link or special, will have a single
         path preferred by the system, but may allow multiple, differing path
         lookups to point to it.
 
         Most regular UNIX file systems only allow a file system entry to be
         looked up by its distinct path. Obviously, this does not apply to case
         insensitive file systems, whether case preserving or not. The most
         complex issue to deal with is file systems transparently reencoding the
         path, such as the non-standard Unicode normalisation required for HFS+
         and HFSX.
         '''
         # Constants copied from /usr/include/sys/fcntl.h
         F_GETPATH = 50
         O_SYMLINK = 0x200000
 
         try:
             fd = os.open(path, O_SYMLINK)
         except OSError, err:
             if err.errno == errno.ENOENT:
                 return path
             raise
 
         try:
             return fcntl.fcntl(fd, F_GETPATH, '\0' * 1024).rstrip('\0')
         finally:
             os.close(fd)
 elif sys.version_info < (2, 4, 2, 'final'):
     # Workaround for http://bugs.python.org/issue1213894 (os.path.realpath
     # didn't resolve symlinks that were the first component of the path.)
     def realpath(path):
         if os.path.isabs(path):
             return os.path.realpath(path)
         else:
             return os.path.realpath('./' + path)
 else:
     # Fallback to the likely inadequate Python builtin function.
     realpath = os.path.realpath
 
 if sys.platform == 'cygwin':
     # workaround for cygwin, in which mount point part of path is
     # treated as case sensitive, even though underlying NTFS is case
     # insensitive.
 
     # default mount points
     cygwinmountpoints = sorted([
             "/usr/bin",
             "/usr/lib",
             "/cygdrive",
             ], reverse=True)
 
     # use upper-ing as normcase as same as NTFS workaround
     def normcase(path):
         pathlen = len(path)
         if (pathlen == 0) or (path[0] != os.sep):
             # treat as relative
             return encoding.upper(path)
 
         # to preserve case of mountpoint part
         for mp in cygwinmountpoints:
             if not path.startswith(mp):
                 continue
 
             mplen = len(mp)
             if mplen == pathlen: # mount point itself
                 return mp
             if path[mplen] == os.sep:
                 return mp + encoding.upper(path[mplen:])
 
         return encoding.upper(path)
 
     # Cygwin translates native ACLs to POSIX permissions,
     # but these translations are not supported by native
     # tools, so the exec bit tends to be set erroneously.
     # Therefore, disable executable bit access on Cygwin.
     def checkexec(path):
         return False
 
     # Similarly, Cygwin's symlink emulation is likely to create
     # problems when Mercurial is used from both Cygwin and native
     # Windows, with other native tools, or on shared volumes
     def checklink(path):
         return False
 
 def shellquote(s):
     if os.sys.platform == 'OpenVMS':
         return '"%s"' % s
     else:
         return "'%s'" % s.replace("'", "'\\''")
 
 def quotecommand(cmd):
     return cmd
 
 def popen(command, mode='r'):
     return os.popen(command, mode)
 
 def testpid(pid):
     '''return False if pid dead, True if running or not sure'''
     if os.sys.platform == 'OpenVMS':
         return True
     try:
         os.kill(pid, 0)
         return True
     except OSError, inst:
         return inst.errno != errno.ESRCH
 
 def explainexit(code):
     """return a 2-tuple (desc, code) describing a subprocess status
     (codes from kill are negative - not os.system/wait encoding)"""
     if code >= 0:
         return _("exited with status %d") % code, code
     return _("killed by signal %d") % -code, -code
 
 def isowner(st):
     """Return True if the stat object st is from the current user."""
     return st.st_uid == os.getuid()
 
 def findexe(command):
     '''Find executable for command searching like which does.
     If command is a basename then PATH is searched for command.
     PATH isn't searched if command is an absolute or relative path.
     If command isn't found None is returned.'''
     if sys.platform == 'OpenVMS':
         return command
 
     def findexisting(executable):
         'Will return executable if existing file'
         if os.path.isfile(executable) and os.access(executable, os.X_OK):
             return executable
         return None
 
     if os.sep in command:
         return findexisting(command)
 
     if sys.platform == 'plan9':
         return findexisting(os.path.join('/bin', command))
 
     for path in os.environ.get('PATH', '').split(os.pathsep):
         executable = findexisting(os.path.join(path, command))
         if executable is not None:
             return executable
     return None
 
 def setsignalhandler():
     pass
 
 _wantedkinds = set([stat.S_IFREG, stat.S_IFLNK])
 
 def statfiles(files):
     '''Stat each file in files. Yield each stat, or None if a file does not
     exist or has a type we don't care about.'''
     lstat = os.lstat
     getkind = stat.S_IFMT
     for nf in files:
         try:
             st = lstat(nf)
             if getkind(st.st_mode) not in _wantedkinds:
                 st = None
         except OSError, err:
             if err.errno not in (errno.ENOENT, errno.ENOTDIR):
                 raise
             st = None
         yield st
 
 def getuser():
     '''return name of current user'''
     return getpass.getuser()
 
 def username(uid=None):
     """Return the name of the user with the given uid.
 
     If uid is None, return the name of the current user."""
 
     if uid is None:
         uid = os.getuid()
     try:
         return pwd.getpwuid(uid)[0]
     except KeyError:
         return str(uid)
 
 def groupname(gid=None):
     """Return the name of the group with the given gid.
 
     If gid is None, return the name of the current group."""
 
     if gid is None:
         gid = os.getgid()
     try:
         return grp.getgrgid(gid)[0]
     except KeyError:
         return str(gid)
 
 def groupmembers(name):
     """Return the list of members of the group with the given
     name, KeyError if the group does not exist.
     """
     return list(grp.getgrnam(name).gr_mem)
 
 def spawndetached(args):
     return os.spawnvp(os.P_NOWAIT | getattr(os, 'P_DETACH', 0),
                       args[0], args)
 
 def gethgcmd():
     return sys.argv[:1]
 
 def termwidth():
     try:
         import termios, array, fcntl
         for dev in (sys.stderr, sys.stdout, sys.stdin):
             try:
                 try:
                     fd = dev.fileno()
                 except AttributeError:
                     continue
                 if not os.isatty(fd):
                     continue
                 try:
                     arri = fcntl.ioctl(fd, termios.TIOCGWINSZ, '\0' * 8)
                     width = array.array('h', arri)[1]
                     if width > 0:
                         return width
                 except AttributeError:
                     pass
             except ValueError:
                 pass
             except IOError, e:
                 if e[0] == errno.EINVAL:
                     pass
                 else:
                     raise
     except ImportError:
         pass
     return 80
 
 def makedir(path, notindexed):
     os.mkdir(path)
 
 def unlinkpath(f):
     """unlink and remove the directory if it is empty"""
     os.unlink(f)
     # try removing directories that might now be empty
     try:
         os.removedirs(os.path.dirname(f))
     except OSError:
         pass
 
 def lookupreg(key, name=None, scope=None):
     return None
 
 def hidewindow():
     """Hide current shell window.
 
     Used to hide the window opened when starting asynchronous
     child process under Windows, unneeded on other systems.
     """
     pass
 
 class cachestat(object):
     def __init__(self, path):
         self.stat = os.stat(path)
 
     def cacheable(self):
         return bool(self.stat.st_ino)
 
     __hash__ = object.__hash__
 
     def __eq__(self, other):
         try:
             return self.stat == other.stat
         except AttributeError:
             return False
 
     def __ne__(self, other):
         return not self == other
 
 def executablepath():
     return None # available on Windows only
+
+class unixdomainserver(socket.socket):
+    def __init__(self, join, subsystem):
+        '''Create a unix domain socket with the given prefix.'''
+        super(unixdomainserver, self).__init__(socket.AF_UNIX)
+        sockname = subsystem + '.sock'
+        self.realpath = self.path = join(sockname)
+        if os.path.islink(self.path):
+            if os.path.exists(self.path):
+                self.realpath = os.readlink(self.path)
+            else:
+                os.unlink(self.path)
+        try:
+            self.bind(self.realpath)
+        except socket.error, err:
+            if err.args[0] == 'AF_UNIX path too long':
+                tmpdir = tempfile.mkdtemp(prefix='hg-%s-' % subsystem)
+                self.realpath = os.path.join(tmpdir, sockname)
+                try:
+                    self.bind(self.realpath)
+                    os.symlink(self.realpath, self.path)
+                except (OSError, socket.error):
+                    self.cleanup()
+                    raise
+            else:
+                raise
+        self.listen(5)
+
+    def cleanup(self):
+        def okayifmissing(f, path):
+            try:
+                f(path)
+            except OSError, err:
+                if err.errno != errno.ENOENT:
+                    raise
+
+        okayifmissing(os.unlink, self.path)
+        if self.realpath != self.path:
+            okayifmissing(os.unlink, self.realpath)
+            okayifmissing(os.rmdir, os.path.dirname(self.realpath))