/src/pigeonhole/src/lib-sieve/storage/file/sieve-file-script.c

Source
/* Copyright (c) Pigeonhole authors, see top-level COPYING file */

#include "lib.h"
#include "mempool.h"
#include "str.h"
#include "path-util.h"
#include "istream.h"
#include "time-util.h"
#include "eacces-error.h"

#include "sieve-dump.h"
#include "sieve-binary.h"
#include "sieve-script-private.h"

#include "sieve-file-storage.h"

#include <stdio.h>
#include <unistd.h>
#include <ctype.h>
#include <time.h>
#include <fcntl.h>

/*
 * Filename to name/name to filename
 */

const char *sieve_script_file_get_scriptname(const char *filename)
{
  const char *ext;

  /* Extract the script name */
  ext = strrchr(filename, '.');
  if (ext == NULL || ext == filename ||
      strcmp(ext, "."SIEVE_SCRIPT_FILEEXT) != 0)
    return NULL;

  return t_strdup_until(filename, ext);
}

bool sieve_script_file_has_extension(const char *filename)
{
  return (sieve_script_file_get_scriptname(filename) != NULL);
}

const char *sieve_script_file_from_name(const char *name)
{
  return t_strconcat(name, "."SIEVE_SCRIPT_FILEEXT, NULL);
}

/*
 * Common error handling
 */

static void
sieve_file_script_handle_error(struct sieve_file_script *fscript,
             const char *op, const char *path,
             const char *name)
{
  struct sieve_script *script = &fscript->script;
  const char *abspath, *error;

  switch (errno) {
  case ENOENT:
    if (t_abspath(path, &abspath, &error) < 0) {
      sieve_script_set_critical(script,
              "t_abspath(%s) failed: %s",
              path, error);
      break;
    }
    e_debug(script->event, "File '%s' not found", abspath);
    sieve_script_set_not_found_error(script, name);
    break;
  case EACCES:
    sieve_script_set_critical(script,
            "Failed to %s sieve script: %s",
            op, eacces_error_get(op, path));
    script->storage->error_code = SIEVE_ERROR_NO_PERMISSION;
    break;
  default:
    sieve_script_set_critical(
      script, "Failed to %s sieve script: %s(%s) failed: %m",
      op, op, path);
    break;
  }
}

/*
 *
 */

static struct sieve_file_script *sieve_file_script_alloc(void)
{
  struct sieve_file_script *fscript;
  pool_t pool;

  pool = pool_alloconly_create("sieve_file_script", 2048);
  fscript = p_new(pool, struct sieve_file_script, 1);
  fscript->script = sieve_file_script;
  fscript->script.pool = pool;

  return fscript;
}

int sieve_file_script_init_from_filename(struct sieve_file_storage *fstorage,
           const char *filename,
           const char *scriptname,
           struct sieve_file_script **fscript_r)
{
  struct sieve_storage *storage = &fstorage->storage;
  struct sieve_file_script *fscript = NULL;

  *fscript_r = NULL;

  /* Prevent initializing the active script link as a script when it
     resides in the sieve storage directory.
   */
  if (scriptname != NULL && fstorage->link_path != NULL &&
      *(fstorage->link_path) == '\0') {
    if (strcmp(filename, fstorage->active_fname) == 0) {
      sieve_storage_set_error(
        storage, SIEVE_ERROR_NOT_FOUND,
        "Script '%s' does not exist.", scriptname);
      return -1;
    }
  }

  fscript = sieve_file_script_alloc();
  sieve_script_init(&fscript->script, storage, &sieve_file_script,
        scriptname);
  fscript->filename = p_strdup(fscript->script.pool, filename);

  event_add_str(fscript->script.event, "sieve_script_file_path",
          sieve_file_storage_path_extend(fstorage, filename));

  *fscript_r = fscript;
  return 0;
}

int sieve_file_script_open_from_filename(struct sieve_file_storage *fstorage,
           const char *filename,
           const char *scriptname,
           struct sieve_file_script **fscript_r)
{
  struct sieve_file_script *fscript;

  *fscript_r = NULL;

  if (sieve_file_script_init_from_filename(fstorage, filename, scriptname,
             &fscript) < 0)
    return -1;

  if (sieve_script_open(&fscript->script, NULL) < 0) {
    struct sieve_script *script = &fscript->script;

    sieve_script_unref(&script);
    return -1;
  }

  *fscript_r = fscript;
  return 0;
}

int sieve_file_script_init_from_name(struct sieve_file_storage *fstorage,
             const char *name,
             struct sieve_file_script **fscript_r)
{
  struct sieve_storage *storage = &fstorage->storage;
  struct sieve_file_script *fscript;

  *fscript_r = NULL;

  if (name != NULL && S_ISDIR(fstorage->st.st_mode)) {
    return sieve_file_script_init_from_filename(
      fstorage, sieve_script_file_from_name(name), name,
      fscript_r);
  }

  fscript = sieve_file_script_alloc();
  sieve_script_init(&fscript->script, storage, &sieve_file_script, name);

  event_add_str(fscript->script.event, "sieve_script_file_path",
          fstorage->active_path);

  *fscript_r = fscript;
  return 0;
}

int sieve_file_script_open_from_name(struct sieve_file_storage *fstorage,
             const char *name,
             struct sieve_file_script **fscript_r)
{
  struct sieve_file_script *fscript;

  *fscript_r = NULL;

  if (sieve_file_script_init_from_name(fstorage, name, &fscript) < 0)
    return -1;

  if (sieve_script_open(&fscript->script, NULL) < 0) {
    struct sieve_script *script = &fscript->script;

    sieve_script_unref(&script);
    return -1;
  }

  *fscript_r = fscript;
  return 0;
}

int sieve_file_script_init_from_path(struct sieve_file_storage *fstorage,
             const char *path, const char *scriptname,
             struct sieve_file_script **fscript_r)
{
  struct sieve_storage *storage = &fstorage->storage;
  struct sieve_instance *svinst = storage->svinst;
  struct sieve_file_storage *fsubstorage;
  struct sieve_file_script *fscript;
  struct sieve_storage *substorage;
  enum sieve_error error_code;
  const char *error;

  *fscript_r = NULL;

  if (sieve_file_storage_init_from_path(svinst, storage->cause,
                storage->type, storage->name,
                path, 0, &fsubstorage,
                &error_code, &error) < 0) {
    sieve_storage_set_error(storage, error_code, "%s", error);
    return -1;
  }
  substorage = &fsubstorage->storage;

  fscript = sieve_file_script_alloc();
  sieve_script_init(&fscript->script, substorage, &sieve_file_script,
        scriptname);
  sieve_storage_unref(&substorage);

  event_add_str(fscript->script.event, "sieve_script_file_path",
          fstorage->active_path);

  *fscript_r = fscript;
  return 0;
}

int sieve_file_script_open_from_path(struct sieve_file_storage *fstorage,
             const char *path, const char *scriptname,
             struct sieve_file_script **fscript_r)
{
  struct sieve_storage *storage = &fstorage->storage;
  struct sieve_file_script *fscript;

  *fscript_r = NULL;

  if (sieve_file_script_init_from_path(fstorage, path, scriptname,
               &fscript) < 0)
    return -1;

  if (sieve_script_open(&fscript->script, NULL) < 0) {
    struct sieve_script *script = &fscript->script;

    sieve_storage_copy_error(storage, script->storage);
    sieve_script_unref(&script);
    return -1;
  }

  *fscript_r = fscript;
  return 0;
}

/*
 * Open
 */

static int
sieve_file_script_stat(const char *path, struct stat *st, struct stat *lnk_st)
{
  if (lstat(path, st) < 0)
    return -1;

  *lnk_st = *st;

  if (S_ISLNK(st->st_mode) && stat(path, st) < 0)
    return -1;
  return 0;
}

/* TOCTOU-safe variant of sieve_file_script_stat() for directory storages.
   Resolves the script entry beneath fstorage->dir_fd, refusing symlinks
   whose target escapes the storage directory. *st gets the (resolved)
   target's stat; *lnk_st gets the directory entry's own stat (i.e.
   AT_SYMLINK_NOFOLLOW), matching the semantics of the unsafe variant. */
static int
sieve_file_script_stat_safe(struct sieve_file_storage *fstorage,
          const char *filename, struct stat *st,
          struct stat *lnk_st, const char **error_r)
{
  int fd, saved_errno;

  i_assert(fstorage->dir_fd >= 0);

  if (fstatat(fstorage->dir_fd, filename, lnk_st,
        AT_SYMLINK_NOFOLLOW) < 0) {
    *error_r = t_strdup_printf(
      "fstatat(%s/%s) failed: %m",
      fstorage->path, filename);
    return -1;
  }

  if (!S_ISLNK(lnk_st->st_mode)) {
    *st = *lnk_st;
    return 0;
  }

  /* Symlink: open it via the safe walker (which refuses any target
     that leaves fstorage->dir_fd) and read st from the resulting fd.
     The fd is only used to fetch the resolved stat and is closed
     immediately. Open with O_NONBLOCK so that a target which resolves
     to a FIFO or other special file inside the storage directory only
     yields its stat instead of blocking the delivery process. */
  if (sieve_file_storage_open_safe(fstorage, filename,
           O_RDONLY | O_NONBLOCK,
           &fd, error_r) < 0)
    return -1;

  if (fstat(fd, st) < 0) {
    saved_errno = errno;
    *error_r = t_strdup_printf(
      "fstat() failed for '%s/%s': %m",
      fstorage->path, filename);
    i_close_fd(&fd);
    errno = saved_errno;
    return -1;
  }
  i_close_fd(&fd);
  return 0;
}

static const char *
path_split_filename(const char *path, const char **dir_path_r)
{
  const char *filename;

  filename = strrchr(path, '/');
  if (filename == NULL) {
    *dir_path_r = "";
    filename = path;
  } else {
    *dir_path_r = t_strdup_until(path, filename);
    filename++;
  }
  return filename;
}

static int sieve_file_script_open(struct sieve_script *script)
{
  struct sieve_file_script *fscript =
    container_of(script, struct sieve_file_script, script);
  struct sieve_storage *storage = script->storage;
  struct sieve_file_storage *fstorage =
    container_of(storage, struct sieve_file_storage, storage);
  pool_t pool = script->pool;
  const char *filename, *name, *path;
  const char *dir_path, *basename, *bin_path, *bin_prefix;
  struct stat st, lnk_st;
  bool success = TRUE;
  int ret = 0;

  filename = fscript->filename;
  basename = NULL;
  name = script->name;
  st = fstorage->st;
  lnk_st = fstorage->lnk_st;

  if (name == NULL && storage->script_name != NULL &&
      *storage->script_name != '\0')
    name = storage->script_name;

  T_BEGIN {
    if (S_ISDIR(st.st_mode)) {
      /* Storage is a directory */
      path = fstorage->path;

      if ((filename == NULL || *filename == '\0') &&
          name != NULL && *name != '\0') {
        /* Name is used to find actual filename */
        filename = sieve_script_file_from_name(name);
        basename = name;
      }
      if (filename == NULL || *filename == '\0') {
        sieve_script_set_critical(
          script, "Sieve script file path '%s' is a directory.", path);
        success = FALSE;
      } else {
        /* Extend storage path with filename */
        if (name == NULL) {
          if (basename == NULL &&
              (basename = sieve_script_file_get_scriptname(filename)) == NULL)
            basename = filename;
          name = basename;
        } else if (basename == NULL) {
          basename = name;
        }
        dir_path = path;

        path = sieve_file_storage_path_extend(fstorage, filename);
        if (fstorage->dir_fd >= 0) {
          const char *serror;

          ret = sieve_file_script_stat_safe(
            fstorage, filename, &st,
            &lnk_st, &serror);
          if (ret < 0 && errno == ELOOP) {
            sieve_script_set_critical(
              script,
              "Failed to open sieve script: %s",
              serror);
            script->storage->error_code =
              SIEVE_ERROR_NO_PERMISSION;
            success = FALSE;
          }
        } else {
          ret = sieve_file_script_stat(
            path, &st, &lnk_st);
        }
      }

    } else {
      /* Storage is a single file */
      path = fstorage->active_path;

      /* Extract filename from path */
      filename = path_split_filename(path, &dir_path);

      basename = sieve_script_file_get_scriptname(filename);
      if (basename == NULL)
        basename = filename;

      if (name == NULL)
        name = basename;
    }

    if (success) {
      if (ret < 0) {
        /* Make sure we have a script name for the error
         */
        if (name == NULL) {
          i_assert(basename != NULL);
          name = basename;
        }
        sieve_file_script_handle_error(fscript, "stat",
                     path, name);
        success = FALSE;

      } else if (!S_ISREG(st.st_mode)) {
        sieve_script_set_critical(
          script, "Sieve script file '%s' is not a regular file.",
          path);
        success = FALSE;
      }
    }

    if (success) {
      const char *bpath, *bfile, *bprefix;

      if (storage->bin_path != NULL) {
        bpath = storage->bin_path;
        bfile = sieve_binfile_from_name(name);
        bprefix = name;

      } else {
        bpath = dir_path;
        bfile = sieve_binfile_from_name(basename);
        bprefix = basename;
      }

      if (*bpath == '\0') {
        bin_path = bfile;
        bin_prefix = bprefix;
      } else if (bpath[strlen(bpath)-1] == '/') {
        bin_path = t_strconcat(bpath, bfile, NULL);
        bin_prefix = t_strconcat(bpath, bprefix, NULL);
      } else {
        bin_path = t_strconcat(bpath, "/", bfile, NULL);
        bin_prefix = t_strconcat(bpath, "/", bprefix, NULL);
      }

      fscript->st = st;
      fscript->lnk_st = lnk_st;
      fscript->path = p_strdup(pool, path);
      fscript->filename = p_strdup(pool, filename);
      fscript->dir_path = p_strdup(pool, dir_path);
      fscript->bin_path = p_strdup(pool, bin_path);
      fscript->bin_prefix = p_strdup(pool, bin_prefix);

      if (fscript->script.name == NULL)
        fscript->script.name = p_strdup(pool, basename);

      event_add_str(script->event, "sieve_script_file_path",
              fscript->path);
    }
  } T_END;

  return (success ? 0 : -1);
}

static int
sieve_file_script_get_stream(struct sieve_script *script,
           struct istream **stream_r)
{
  struct sieve_file_script *fscript =
    container_of(script, struct sieve_file_script, script);
  struct sieve_file_storage *fstorage =
    container_of(script->storage, struct sieve_file_storage,
           storage);
  struct stat st;
  struct istream *result;
  const char *error;
  int fd;

  /* For directory-based storage, open the script via the storage
     directory fd so that path resolution refuses to follow symlinks
     whose (recursive) target leaves the storage directory. The fd-based
     walk also makes this TOCTOU-safe: even if intermediate path
     components are mutated between the stat in sieve_file_script_open()
     and this call, the resolution stays within the original directory.
     Single-file storages have no dir_fd, so fall back to a plain open(). */
  if (fstorage->dir_fd >= 0 && fscript->filename != NULL &&
      *fscript->filename != '\0') {
    if (sieve_file_storage_open_safe(fstorage, fscript->filename,
             O_RDONLY, &fd, &error) < 0) {
      if (errno == ELOOP) {
        sieve_script_set_critical(
          script,
          "Failed to open sieve script: %s",
          error);
        script->storage->error_code =
          SIEVE_ERROR_NO_PERMISSION;
        return -1;
      }
      sieve_file_script_handle_error(fscript, "open",
                   fscript->path,
                   fscript->script.name);
      return -1;
    }
  } else {
    fd = open(fscript->path, O_RDONLY);
    if (fd < 0) {
      sieve_file_script_handle_error(fscript, "open",
                   fscript->path,
                   fscript->script.name);
      return -1;
    }
  }

  if (fstat(fd, &st) != 0) {
    sieve_script_set_critical(
      script,
      "Failed to open sieve script: fstat(fd=%s) failed: %m",
      fscript->path);
    result = NULL;
  /* Re-check the file type just to be sure */
  } else if (!S_ISREG(st.st_mode)) {
    sieve_script_set_critical(
      script, "Sieve script file '%s' is not a regular file",
      fscript->path);
    result = NULL;
  } else {
    result = i_stream_create_fd_autoclose(
      &fd, SIEVE_FILE_READ_BLOCK_SIZE);
    fscript->st = fscript->lnk_st = st;
  }

  if (result == NULL) {
    /* Something went wrong, close the fd */
    if (fd >= 0 && close(fd) != 0) {
      e_error(script->event,
        "Failed to close sieve script: "
        "close(fd=%s) failed: %m", fscript->path);
    }
    return -1;
  }

  *stream_r = result;
  return 0;
}

/*
 * Binary
 */

static int
sieve_file_script_binary_read_metadata(struct sieve_script *script,
               struct sieve_binary_block *sblock,
               sieve_size_t *offset)
{
  struct sieve_instance *svinst = script->storage->svinst;
  struct sieve_file_script *fscript =
    container_of(script, struct sieve_file_script, script);
  struct sieve_binary *sbin = sieve_binary_block_get_binary(sblock);
  string_t *path;

  /* Open if not open already */
  if (sieve_script_open(script, NULL) < 0)
    return 0;

  /* Metadata: path */
  if (!sieve_binary_read_string(sblock, offset, &path)) {
    e_error(script->event,
      "Binary '%s' has invalid metadata for script '%s': "
      "Invalid file path",
      sieve_binary_path(sbin), sieve_script_label(script));
    return -1;
  }
  i_assert(fscript->path != NULL);
  if (strcmp(str_c(path), fscript->path) != 0) {
    e_debug(script->event,
      "Binary '%s' reports different file path for script '%s' "
      "('%s' rather than '%s')",
      sieve_binary_path(sbin), sieve_script_label(script),
      str_c(path), fscript->path);
    return 0;
  }

  const struct stat *sstat, *bstat;

  bstat = sieve_binary_stat(sbin);
  if (fscript->st.st_mtime > fscript->lnk_st.st_mtime ||
      (fscript->st.st_mtime == fscript->lnk_st.st_mtime &&
       ST_MTIME_NSEC(fscript->st) >= ST_MTIME_NSEC(fscript->lnk_st))) {
    sstat = &fscript->st;
  } else {
    sstat = &fscript->lnk_st;
  }

  if (bstat->st_mtime < sstat->st_mtime ||
      (bstat->st_mtime == sstat->st_mtime &&
       ST_MTIME_NSEC(*bstat) <= ST_MTIME_NSEC(*sstat))) {
    if (svinst->debug) {
      e_debug(script->event,
        "Sieve binary '%s' is not newer "
        "than the Sieve script '%s' (path=%s, %s.%lu <= %s.%lu)",
        sieve_binary_path(sbin), sieve_script_label(script),
        fscript->path,
        t_strflocaltime("%Y-%m-%d %H:%M:%S",
            bstat->st_mtime),
        ST_MTIME_NSEC(*bstat),
        t_strflocaltime("%Y-%m-%d %H:%M:%S",
            sstat->st_mtime),
        ST_MTIME_NSEC(*sstat));
    }
    return 0;
  }

  return 1;
}

static void
sieve_file_script_binary_write_metadata(struct sieve_script *script,
          struct sieve_binary_block *sblock)
{
  struct sieve_file_script *fscript =
    container_of(script, struct sieve_file_script, script);

  sieve_binary_emit_cstring(sblock, fscript->path);
}

static bool
sieve_file_script_binary_dump_metadata(struct sieve_script *script ATTR_UNUSED,
               struct sieve_dumptime_env *denv,
               struct sieve_binary_block *sblock,
               sieve_size_t *offset)
{
  string_t *path;

  if (!sieve_binary_read_string(sblock, offset, &path))
    return FALSE;
  sieve_binary_dumpf(denv, "file.path = %s\n", str_c(path));

  return TRUE;
}

static int
sieve_file_script_binary_load(struct sieve_script *script,
            struct sieve_binary **sbin_r)
{
  struct sieve_file_script *fscript =
    container_of(script, struct sieve_file_script, script);

  return sieve_script_binary_load_default(script, fscript->bin_path,
            sbin_r);
}

static int
sieve_file_script_binary_save(struct sieve_script *script,
            struct sieve_binary *sbin, bool update)
{
  struct sieve_file_script *fscript =
    container_of(script, struct sieve_file_script, script);

  return sieve_script_binary_save_default(
    script, sbin, fscript->bin_path, update,
    (fscript->st.st_mode & 0777));
}

static const char *
sieve_file_script_binary_get_prefix(struct sieve_script *script)
{
  struct sieve_file_script *fscript =
    container_of(script, struct sieve_file_script, script);

  return fscript->bin_prefix;
}

/*
 * Management
 */

static int sieve_file_storage_script_is_active(struct sieve_script *script)
{
  struct sieve_file_script *fscript =
    container_of(script, struct sieve_file_script, script);
  struct sieve_file_storage *fstorage =
    container_of(script->storage, struct sieve_file_storage,
           storage);
  const char *afile;
  int ret = 0;

  T_BEGIN {
    ret = sieve_file_storage_active_script_get_file(
      fstorage, &afile);

    if (ret > 0) {
      /* Is the requested script active? */
      ret = (strcmp(fscript->filename, afile) == 0 ? 1 : 0);
    }
  } T_END;

  return ret;
}

static int sieve_file_storage_script_delete(struct sieve_script *script)
{
  struct sieve_file_script *fscript =
    container_of(script, struct sieve_file_script, script);
  int ret = 0;

  if (sieve_file_storage_pre_modify(script->storage) < 0)
    return -1;

  ret = unlink(fscript->path);
  if (ret < 0) {
    if (errno == ENOENT) {
      sieve_script_set_error(script, SIEVE_ERROR_NOT_FOUND,
                 "Sieve script does not exist.");
    } else {
      sieve_script_set_critical(
        script,
        "Performing unlink() failed on sieve file '%s': %m",
        fscript->path);
    }
  }

  /* Best-effort: drop the compiled binary as well so it does not
     linger as a stale orphan. */
  if (fscript->bin_path != NULL &&
      unlink(fscript->bin_path) < 0 && errno != ENOENT) {
    e_error(script->event,
      "unlink(%s) failed: %m", fscript->bin_path);
  }
  return ret;
}

static int
_sieve_file_storage_script_activate(struct sieve_file_script *fscript)
{
  struct sieve_script *script = &fscript->script;
  struct sieve_storage *storage = script->storage;
  struct sieve_file_storage *fstorage =
    container_of(storage, struct sieve_file_storage, storage);
  struct stat st;
  const char *link_path, *afile;
  int activated = 0;
  int ret;

  /* Find out whether there is an active script, but recreate
     the symlink either way. This way, any possible error in the symlink
     resolves automatically. This step is only necessary to provide a
     proper return value indicating whether the script was already active.
   */
  ret = sieve_file_storage_active_script_get_file(fstorage, &afile);

  /* Is the requested script already active? */
  if (ret <= 0 || strcmp(fscript->filename, afile) != 0)
    activated = 1;

  i_assert(fstorage->link_path != NULL);

  /* Check the scriptfile we are trying to activate */
  if (lstat(fscript->path, &st) != 0) {
    sieve_script_set_critical(
      script,
      "Failed to activate Sieve script: lstat(%s) failed: %m.",
      fscript->path);
    return -1;
  }

  /* Rescue a possible ".dovecot.sieve" regular file remaining from old
     installations.
   */
  if (!sieve_file_storage_active_rescue_regular(fstorage)) {
    /* Rescue failed, manual intervention is necessary */
    return -1;
  }

  /* Just try to create the symlink first */
  link_path = t_strconcat(fstorage->link_path, fscript->filename, NULL);

  ret = symlink(link_path, fstorage->active_path);
  if (ret < 0) {
    if (errno == EEXIST) {
      ret = sieve_file_storage_active_replace_link(
        fstorage, link_path);
      if (ret < 0)
        return ret;
    } else {
      /* Other error, critical */
      sieve_script_set_critical(
        script, "Failed to activate Sieve script: "
        "symlink(%s, %s) failed: %m",
        link_path, fstorage->active_path);
      return -1;
    }
  }
  return activated;
}

static int sieve_file_storage_script_activate(struct sieve_script *script)
{
  struct sieve_file_script *fscript =
    container_of(script, struct sieve_file_script, script);
  int ret;

  if (sieve_file_storage_pre_modify(script->storage) < 0)
    return -1;

  T_BEGIN {
    ret = _sieve_file_storage_script_activate(fscript);
  } T_END;

  return ret;
}

static int
sieve_file_storage_script_rename(struct sieve_script *script,
         const char *newname)
{
  struct sieve_file_script *fscript =
    container_of(script, struct sieve_file_script, script);
  struct sieve_storage *storage = script->storage;
  struct sieve_file_storage *fstorage =
    container_of(storage, struct sieve_file_storage, storage);
  const char *newpath, *newfile, *link_path;
  int ret = 0;

  if (sieve_file_storage_pre_modify(storage) < 0)
    return -1;

  T_BEGIN {
    newfile = sieve_script_file_from_name(newname);
    newpath = t_strconcat(fstorage->path, "/", newfile, NULL);

    /* The normal rename() system call overwrites the existing file
       without notice. Also, active scripts must not be disrupted by
       renaming a script. That is why we use a link(newpath)
       [activate newpath] unlink(oldpath)
     */

    /* Link to the new path */
    ret = link(fscript->path, newpath);
    if (ret >= 0) {
      /* Is the requested script active? */
      if (sieve_script_is_active(script) > 0) {
        /* Active; make active link point to the new
           copy */
        i_assert(fstorage->link_path != NULL);
        link_path = t_strconcat(fstorage->link_path,
              newfile, NULL);

        ret = sieve_file_storage_active_replace_link(
          fstorage, link_path);
      }

      if (ret >= 0) {
        /* If all is good, remove the old link */
        if (unlink(fscript->path) < 0) {
          e_error(script->event,
            "Failed to clean up after rename: "
            "unlink(%s) failed: %m",
            fscript->path);
        }

        /* Drop the old compiled binary; the renamed
           script will recompile under its new name. */
        if (fscript->bin_path != NULL &&
            unlink(fscript->bin_path) < 0 &&
            errno != ENOENT) {
          e_error(script->event,
            "unlink(%s) failed: %m",
            fscript->bin_path);
        }

        if (script->name != NULL && *script->name != '\0')
          script->name = p_strdup(script->pool, newname);
        fscript->path = p_strdup(script->pool, newpath);
        fscript->filename = p_strdup(script->pool, newfile);
      } else {
        /* If something went wrong, remove the new link
           to restore previous state */
        if (unlink(newpath) < 0) {
          e_error(script->event,
            "Failed to clean up after failed rename: "
            "unlink(%s) failed: %m", newpath);
        }
      }
    } else {
      /* Our efforts failed right away */
      switch (errno) {
      case ENOENT:
        sieve_script_set_error(
          script, SIEVE_ERROR_NOT_FOUND,
          "Sieve script does not exist.");
        break;
      case EEXIST:
        sieve_script_set_error(
          script, SIEVE_ERROR_EXISTS,
          "A sieve script with that name already exists.");
        break;
      default:
        sieve_script_set_critical(
          script, "Failed to rename Sieve script: "
          "link(%s, %s) failed: %m",
          fscript->path, newpath);
      }
    }
  } T_END;

  return ret;
}

/*
 * Properties
 */

static int
sieve_file_script_get_size(const struct sieve_script *script, uoff_t *size_r)
{
  const struct sieve_file_script *fscript =
    container_of(script, const struct sieve_file_script, script);

  *size_r = fscript->st.st_size;
  return 1;
}

const char *sieve_file_script_get_dir_path(const struct sieve_script *script)
{
  const struct sieve_file_script *fscript =
    container_of(script, const struct sieve_file_script, script);

  if (script->driver_name != sieve_file_script.driver_name)
    return NULL;

  return fscript->dir_path;
}

const char *sieve_file_script_get_path(const struct sieve_script *script)
{
  const struct sieve_file_script *fscript =
    container_of(script, const struct sieve_file_script, script);

  if (script->driver_name != sieve_file_script.driver_name)
    return NULL;

  return fscript->path;
}

/*
 * Matching
 */

static int
sieve_file_script_cmp(const struct sieve_script *script1,
          const struct sieve_script *script2)
{
  const struct sieve_file_script *fscript1 =
    container_of(script1, const struct sieve_file_script, script);
  const struct sieve_file_script *fscript2 =
    container_of(script2, const struct sieve_file_script, script);
  int ret;

  if (!script1->open || !script2->open) {
    ret = sieve_storage_cmp(script1->storage, script2->storage);
    if (ret != 0)
      return ret;

    return null_strcmp(script1->name, script2->name);
  }

  if (major(fscript1->st.st_dev) != major(fscript2->st.st_dev)) {
    return (major(fscript1->st.st_dev) >
      major(fscript2->st.st_dev) ? 1 : -1);
  }
  if (minor(fscript1->st.st_dev) != minor(fscript2->st.st_dev)) {
    return (minor(fscript1->st.st_dev) >
      minor(fscript2->st.st_dev) ? 1 : -1);
  }

  if (fscript1->st.st_ino != fscript2->st.st_ino)
    return (fscript1->st.st_ino > fscript2->st.st_ino ? 1 : -1);

  return 0;
}

/*
 * Driver definition
 */

const struct sieve_script sieve_file_script = {
  .driver_name = SIEVE_FILE_STORAGE_DRIVER_NAME,
  .v = {
    .open = sieve_file_script_open,

    .get_stream = sieve_file_script_get_stream,

    .binary_read_metadata = sieve_file_script_binary_read_metadata,
    .binary_write_metadata =
      sieve_file_script_binary_write_metadata,
    .binary_dump_metadata = sieve_file_script_binary_dump_metadata,
    .binary_load = sieve_file_script_binary_load,
    .binary_save = sieve_file_script_binary_save,
    .binary_get_prefix = sieve_file_script_binary_get_prefix,

    .rename = sieve_file_storage_script_rename,
    .delete = sieve_file_storage_script_delete,
    .is_active = sieve_file_storage_script_is_active,
    .activate = sieve_file_storage_script_activate,

    .get_size = sieve_file_script_get_size,

    .cmp = sieve_file_script_cmp,
  }
};

Coverage Report

Created: 2026-10-17 06:32