src/editor/editlock.c

   1 /* editor file locking.
   2
   3    Copyright (C) 2003, 2004, 2005, 2006, 2007 Free Software Foundation, Inc.
   4
   5    Authors: 2003 Adam Byrtek
   6
   7    This program is free software; you can redistribute it and/or modify
   8    it under the terms of the GNU General Public License as published by
   9    the Free Software Foundation; either version 2 of the License, or
  10    (at your option) any later version.
  11
  12    This program is distributed in the hope that it will be useful,
  13    but WITHOUT ANY WARRANTY; without even the implied warranty of
  14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15    GNU General Public License for more details.
  16
  17    You should have received a copy of the GNU General Public License
  18    along with this program; if not, write to the Free Software
  19    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  20    02110-1301, USA.
  21
  22 */
  23
  24 /** \file
  25  *  \brief Source: editor file locking
  26  *  \author Adam Byrtek
  27  *  \date 2003
  28  *
  29  *  Locking scheme used in mcedit is based on a documentation found
  30  *  in JED editor sources. Abstract from lock.c file (by John E. Davis):
  31  *
  32  *  The basic idea here is quite simple.  Whenever a buffer is attached to
  33  *  a file, and that buffer is modified, then attempt to lock the
  34  *  file. Moreover, before writing to a file for any reason, lock the
  35  *  file. The lock is really a protocol respected and not a real lock.
  36  *  The protocol is this: If in the directory of the file is a
  37  *  symbolic link with name ".#FILE", the FILE is considered to be locked
  38  *  by the process specified by the link.
  39  */
  40
  41 #include <config.h>
  42
  43 #include <signal.h>             /* kill() */
  44 #include <stdio.h>
  45 #include <stdarg.h>
  46 #include <sys/types.h>
  47 #include <unistd.h>
  48 #include <string.h>
  49 #include <ctype.h>
  50 #include <errno.h>
  51 #include <sys/stat.h>
  52 #include <pwd.h>
  53 #include <stdlib.h>
  54
  55 #include "lib/global.h"
  56 #include "lib/vfs/mc-vfs/vfs.h"
  57 #include "lib/strutil.h"        /* utf string functions */
  58
  59
  60 #include "edit-impl.h"
  61 #include "editlock.h"
  62
  63 #include "src/wtools.h" /* edit_query_dialog () */
  64
  65 #define BUF_SIZE 255
  66 #define PID_BUF_SIZE 10
  67
  68 struct lock_s {
  69     char *who;
  70     pid_t pid;
  71 };
  72
  73 /** \fn static char * lock_build_name (void)
  74  *  \brief builds user@host.domain.pid string (need to be freed)
  75  *  \return a pointer to lock filename
  76  */
  77 static char *
  78 lock_build_name (void)
  79 {
  80     char host[BUF_SIZE];
  81     const char *user = NULL;
  82     struct passwd *pw;
  83
  84     pw = getpwuid (getuid ());
  85     if (pw) user = pw->pw_name;
  86     if (!user) user = getenv ("USER");
  87     if (!user) user = getenv ("USERNAME");
  88     if (!user) user = getenv ("LOGNAME");
  89     if (!user) user = "";
  90
  91     /** \todo Use FQDN, no clean interface, so requires lot of code */
  92     if (gethostname (host, BUF_SIZE - 1) == -1)
  93         *host = '\0';
  94
  95     return g_strdup_printf ("%s@%s.%d", user, host, (int) getpid ());
  96 }
  97
  98 static char *
  99 lock_build_symlink_name (const char *fname)
 100 {
 101     char *fname_copy, *symlink_name;
 102     char absolute_fname[PATH_MAX];
 103
 104     if (mc_realpath (fname, absolute_fname) == NULL)
 105         return NULL;
 106
 107     fname = x_basename (absolute_fname);
 108     fname_copy = g_strdup (fname);
 109     absolute_fname[fname - absolute_fname] = '\0';
 110     symlink_name = g_strconcat (absolute_fname, ".#", fname_copy, (char *) NULL);
 111     g_free (fname_copy);
 112
 113     return symlink_name;
 114 }
 115
 116 /* Extract pid from user@host.domain.pid string */
 117 static struct lock_s *
 118 lock_extract_info (const char *str)
 119 {
 120     size_t i, len;
 121     const char *p, *s;
 122     static char pid[PID_BUF_SIZE], who[BUF_SIZE];
 123     static struct lock_s lock;
 124
 125     len = strlen (str);
 126
 127     for (p = str + len - 1; p >= str; p--)
 128         if (*p == '.')
 129             break;
 130
 131     /* Everything before last '.' is user@host */
 132     i = 0;
 133     for (s = str; s < p && i < BUF_SIZE; s++)
 134         who[i++] = *s;
 135     who[i] = '\0';
 136
 137     /* Treat text between '.' and ':' or '\0' as pid */
 138     i = 0;
 139     for (p = p + 1; (p < str + len) && (*p != ':') && (i < PID_BUF_SIZE); p++)
 140         pid[i++] = *p;
 141     pid[i] = '\0';
 142
 143     lock.pid = (pid_t) atol (pid);
 144     lock.who = who;
 145     return &lock;
 146 }
 147
 148 /* Extract user@host.domain.pid from lock file (static string)  */
 149 static char *
 150 lock_get_info (const char *lockfname)
 151 {
 152     int cnt;
 153     static char buf[BUF_SIZE];
 154
 155     if ((cnt = readlink (lockfname, buf, BUF_SIZE - 1)) == -1 || !*buf)
 156         return NULL;
 157     buf[cnt] = '\0';
 158     return buf;
 159 }
 160
 161
 162 /* Tries to raise file lock
 163    Returns 1 on success,  0 on failure, -1 if abort
 164    Warning: Might do screen refresh and lose edit->force */
 165 int
 166 edit_lock_file (const char *fname)
 167 {
 168     char *lockfname, *newlock, *msg, *lock;
 169     struct stat statbuf;
 170     struct lock_s *lockinfo;
 171
 172     /* Just to be sure (and don't lock new file) */
 173     if (!fname || !*fname)
 174         return 0;
 175
 176     /* Locking on VFS is not supported */
 177     if (!vfs_file_is_local (fname))
 178         return 0;
 179
 180     /* Check if already locked */
 181     lockfname = lock_build_symlink_name (fname);
 182     if (lockfname == NULL)
 183         return 0;
 184     if (lstat (lockfname, &statbuf) == 0) {
 185         lock = lock_get_info (lockfname);
 186         if (!lock) {
 187             g_free (lockfname);
 188             return 0;
 189         }
 190         lockinfo = lock_extract_info (lock);
 191
 192         /* Check if locking process alive, ask user if required */
 193         if (!lockinfo->pid
 194             || !(kill (lockinfo->pid, 0) == -1 && errno == ESRCH)) {
 195             msg =
 196                 g_strdup_printf (_
 197                                  ("File \"%s\" is already being edited\n"
 198                                   "User: %s\nProcess ID: %d"), x_basename (lockfname) + 2,
 199                                  lockinfo->who, (int) lockinfo->pid);
 200             /* TODO: Implement "Abort" - needs to rewind undo stack */
 201             switch (edit_query_dialog2
 202                     (_("File locked"), msg, _("&Grab lock"),
 203                      _("&Ignore lock"))) {
 204             case 0:
 205                 break;
 206             case 1:
 207             case -1:
 208                 g_free (lockfname);
 209                 g_free (msg);
 210                 return 0;
 211             }
 212             g_free (msg);
 213         }
 214         unlink (lockfname);
 215     }
 216
 217     /* Create lock symlink */
 218     newlock = lock_build_name ();
 219     if (symlink (newlock, lockfname) == -1) {
 220         g_free (lockfname);
 221         g_free (newlock);
 222         return 0;
 223     }
 224
 225     g_free (lockfname);
 226     g_free (newlock);
 227     return 1;
 228 }
 229
 230 /* Lowers file lock if possible
 231    Always returns 0 to make 'lock = edit_unlock_file (f)' possible */
 232 int
 233 edit_unlock_file (const char *fname)
 234 {
 235     char *lockfname, *lock;
 236     struct stat statbuf;
 237
 238     /* Just to be sure */
 239     if (!fname || !*fname)
 240         return 0;
 241
 242     lockfname = lock_build_symlink_name (fname);
 243     if (lockfname == NULL)
 244         return 0;
 245
 246     /* Check if lock exists */
 247     if (lstat (lockfname, &statbuf) == -1) {
 248         g_free (lockfname);
 249         return 0;
 250     }
 251
 252     lock = lock_get_info (lockfname);
 253     if (lock) {
 254         /* Don't touch if lock is not ours */
 255         if (lock_extract_info (lock)->pid != getpid ()) {
 256             g_free (lockfname);
 257             return 0;
 258         }
 259     }
 260
 261     /* Remove lock */
 262     unlink (lockfname);
 263     g_free (lockfname);
 264     return 0;
 265 }