RISCOS/Modules/riscosmodule.c

/* RISCOS module implementation */

#include "oslib/osfscontrol.h"
#include "oslib/osgbpb.h"
#include "oslib/os.h"
#include "oslib/osfile.h"
#include "unixstuff.h"

#include <sys/fcntl.h>

#include "Python.h"
#include "structseq.h"

#include <errno.h>

static os_error *e;

/*static PyObject *RiscosError;*/ /* Exception riscos.error */

static PyObject *riscos_error(char *s)
{
    PyErr_SetString(PyExc_OSError, s);
    return NULL;
}

static PyObject *riscos_oserror(void)
{
    return riscos_error(e->errmess);
}


/* RISCOS file commands */

static PyObject *
riscos_remove(PyObject *self, PyObject *args)
{
    char *path1;
    if (!PyArg_ParseTuple(args, "s:remove", &path1)) return NULL;
    if (remove(path1)) return PyErr_SetFromErrno(PyExc_OSError);
    Py_INCREF(Py_None);
    return Py_None;
}

static PyObject *
riscos_rename(PyObject *self, PyObject *args)
{
    char *path1, *path2;
    if (!PyArg_ParseTuple(args, "ss:rename", &path1, &path2))
        return NULL;
    if (rename(path1,path2)) return PyErr_SetFromErrno(PyExc_OSError);
    Py_INCREF(Py_None);
    return Py_None;
}

static PyObject *
riscos_system(PyObject *self, PyObject *args)
{
    char *command;
    if (!PyArg_ParseTuple(args, "s:system", &command)) return NULL;
    return PyInt_FromLong(system(command));
}

static PyObject *
riscos_chdir(PyObject *self, PyObject *args)
{
    char *path;
    if (!PyArg_ParseTuple(args, "s:chdir", &path)) return NULL;
    e=xosfscontrol_dir(path);
    if(e) return riscos_oserror();
    Py_INCREF(Py_None);
    return Py_None;
}

static PyObject *
canon(char *path)
{
  int len;
  PyObject *obj;
  char *buf;
  e=xosfscontrol_canonicalise_path(path,0,0,0,0,&len);
  if(e) return riscos_oserror();
  obj=PyString_FromStringAndSize(NULL,-len);
  if(obj==NULL) return NULL;
  buf=PyString_AsString(obj);
  e=xosfscontrol_canonicalise_path(path,buf,0,0,1-len,&len);
  if(len!=1) return riscos_error("Error expanding path");
  if(!e) return obj;
  Py_DECREF(obj);
  return riscos_oserror();
}

static PyObject *
riscos_getcwd(PyObject *self, PyObject *unused)
{
    return canon("@");
}

static PyObject *
riscos_expand(PyObject *self, PyObject *args)
{
    char *path;
    if (!PyArg_ParseTuple(args, "s:expand", &path)) return NULL;
    return canon(path);
}

static PyObject *
riscos_mkdir(PyObject *self, PyObject *args)
{
    char *path;
    int mode;
    if (!PyArg_ParseTuple(args, "s|i:mkdir", &path, &mode)) return NULL;
    e=xosfile_create_dir(path,0);
    if(e) return riscos_oserror();
    Py_INCREF(Py_None);
    return Py_None;
}

static PyObject *
riscos_listdir(PyObject *self, PyObject *args)
{
    char *path,buf[256];
    PyObject *d, *v;
    int c=0,count;
    if (!PyArg_ParseTuple(args, "s:listdir", &path)) return NULL;
    d=PyList_New(0);
    if(!d) return NULL;
    for(;;)
    { e=xosgbpb_dir_entries(path,(osgbpb_string_list*)buf,
                                 1,c,256,0,&count,&c);
      if(e)
      { Py_DECREF(d);return riscos_oserror();
      }
      if(count)
      { v=PyString_FromString(buf);
        if(!v) { Py_DECREF(d);return 0;}
        if(PyList_Append(d,v)) {Py_DECREF(d);Py_DECREF(v);return 0;}
      }
      if(c==-1) break;
    }
    return d;
}

PyDoc_STRVAR(stat_result__doc__,
"stat_result: Result from stat or lstat.\n\n\
This object may be accessed either as a tuple of\n\
  (mode,ino,dev,nlink,uid,gid,size,atime,mtime,ctime)\n\
or via the attributes st_mode, st_ino, st_dev, st_nlink, st_uid, and so on.\n\
\n\
RiscOS: The fields st_ftype, st_attrs, and st_obtype are also available.\n\
\n\
See os.stat for more information.");

static PyStructSequence_Field stat_result_fields[] = {
    { "st_mode",  "protection bits" },
    { "st_ino",   "inode" },
    { "st_dev",   "device" },
    { "st_nlink", "number of hard links" },
    { "st_uid",   "user ID of owner" },
    { "st_gid",   "group ID of owner" },
    { "st_size",  "total size, in bytes" },
    { "st_atime", "time of last access" },
    { "st_mtime", "time of last modification" },
    { "st_ctime", "time of last change" },
    { "st_ftype", "file type" },
    { "st_attrs", "attributes" },
    { "st_obtype", "object type" },
    { 0 }
};

static PyStructSequence_Desc stat_result_desc = {
    "riscos.stat_result",
    stat_result__doc__,
    stat_result_fields,
    13
};

static PyTypeObject StatResultType;

static PyObject *
riscos_stat(PyObject *self, PyObject *args)
{
    PyObject *v;
    char *path;
    int ob,len;
    bits t=0;
    bits ld,ex,at,ft,mode;
    if (!PyArg_ParseTuple(args, "s:stat", &path)) return NULL;
    e=xosfile_read_stamped_no_path(path,&ob,&ld,&ex,&len,&at,&ft);
    if(e) return riscos_oserror();
    switch (ob)
    { case osfile_IS_FILE:mode=0100000;break;  /* OCTAL */
      case osfile_IS_DIR:mode=040000;break;
      case osfile_IS_IMAGE:mode=0140000;break;
      default:return riscos_error("Not found");
    }
    if(ft!=-1) t=unixtime(ld,ex);
    mode|=(at&7)<<6;
    mode|=((at&112)*9)>>4;

    v = PyStructSequence_New(&StatResultType);

    PyStructSequence_SET_ITEM(v, 0,
                              PyInt_FromLong((long) mode)); /*st_mode*/
    PyStructSequence_SET_ITEM(v, 1, PyInt_FromLong((long) 0)); /*st_ino*/
    PyStructSequence_SET_ITEM(v, 2, PyInt_FromLong((long) 0)); /*st_dev*/
    PyStructSequence_SET_ITEM(v, 3, PyInt_FromLong((long) 0)); /*st_nlink*/
    PyStructSequence_SET_ITEM(v, 4, PyInt_FromLong((long) 0)); /*st_uid*/
    PyStructSequence_SET_ITEM(v, 5, PyInt_FromLong((long) 0)); /*st_gid*/
    PyStructSequence_SET_ITEM(v, 6,
                              PyInt_FromLong((long) len)); /*st_size*/
    PyStructSequence_SET_ITEM(v, 7, PyInt_FromLong((long) t)); /*st_atime*/
    PyStructSequence_SET_ITEM(v, 8, PyInt_FromLong((long) t)); /*st_mtime*/
    PyStructSequence_SET_ITEM(v, 9, PyInt_FromLong((long) t)); /*st_ctime*/
    PyStructSequence_SET_ITEM(v, 10,
                              PyInt_FromLong((long) ft)); /*file type*/
    PyStructSequence_SET_ITEM(v, 11,
                              PyInt_FromLong((long) at)); /*attributes*/
    PyStructSequence_SET_ITEM(v, 12,
                              PyInt_FromLong((long) ob)); /*object type*/

    if (PyErr_Occurred()) {
        Py_DECREF(v);
        return NULL;
    }

    return v;
}

static PyObject *
riscos_chmod(PyObject *self,PyObject *args)
{
    char *path;
    bits mode;
    bits attr;
    attr=(mode&0x700)>>8;
    attr|=(mode&7)<<4;
    if (!PyArg_ParseTuple(args, "si:chmod", &path,(int*)&mode)) return NULL;
    e=xosfile_write_attr(path,attr);
    if(e) return riscos_oserror();
    Py_INCREF(Py_None);
    return Py_None;
}


static PyObject *
riscos_utime(PyObject *self, PyObject *args)
{
    char *path;
    long atime, mtime;
    PyObject* arg;

    if (!PyArg_ParseTuple(args, "sO:utime", &path, &arg))
        return NULL;

    if (arg == Py_None) {
        /* optional time values not given */
        Py_BEGIN_ALLOW_THREADS
        e=xosfile_stamp(path);
        Py_END_ALLOW_THREADS
        if(e) return riscos_oserror();
    }
    else if (!PyArg_Parse(arg, "(ll)", &atime, &mtime)) {
        PyErr_SetString(PyExc_TypeError,
                        "utime() arg 2 must be a tuple (atime, mtime)");
        return NULL;
    }
    else {
        /* catalogue info*/
        fileswitch_object_type obj_type;
        bits load_addr, exec_addr;
        int size;
        fileswitch_attr attr;

        /* read old catalogue info */
        Py_BEGIN_ALLOW_THREADS
        e=xosfile_read_no_path(path, &obj_type, &load_addr, &exec_addr, &size, &attr);
        Py_END_ALLOW_THREADS
        if(e) return riscos_oserror();

        /* check if load and exec address really contain filetype and date */
        if ( (load_addr & 0xFFF00000U) != 0xFFF00000U)
            return riscos_error("can't set date for object with load and exec addresses");

        /* convert argument mtime to RISC OS load and exec address */
        if(acorntime(&exec_addr, &load_addr, (time_t) mtime))
            return riscos_oserror();

        /* write new load and exec address */
        Py_BEGIN_ALLOW_THREADS
        e = xosfile_write(path, load_addr, exec_addr, attr);
        Py_END_ALLOW_THREADS
        if(e) return riscos_oserror();
    }

    Py_INCREF(Py_None);
    return Py_None;
}

static PyObject *
riscos_settype(PyObject *self, PyObject *args)
{
    char *path,*name;
    int type;
    if (!PyArg_ParseTuple(args, "si:settype", &path,&type))
    {
      PyErr_Clear();
      if (!PyArg_ParseTuple(args, "ss:settype", &path,&name)) return NULL;
      e=xosfscontrol_file_type_from_string(name,(bits*)&type);
      if(e) return riscos_oserror();
    }
    e=xosfile_set_type(path,type);
    if(e) return riscos_oserror();
    Py_INCREF(Py_None);
    return Py_None;
}

static PyObject *
riscos_getenv(PyObject *self, PyObject *args)
{
  char *name,*value;
  if(!PyArg_ParseTuple(args,"s:getenv",&name)) return NULL;
  value=getenv(name);
  if(value) return PyString_FromString(value);
  Py_INCREF(Py_None);
  return Py_None;
}

static PyObject *
riscos_putenv(PyObject *self, PyObject *args)
{
  char *name,*value;
  int len;
  os_var_type type=os_VARTYPE_LITERAL_STRING;
  if(!PyArg_ParseTuple(args,"ss|i:putenv",&name,&value,&type)) return NULL;
  if(type!=os_VARTYPE_STRING&&type!=os_VARTYPE_MACRO&&type!=os_VARTYPE_EXPANDED
                            &&type!=os_VARTYPE_LITERAL_STRING)
    return riscos_error("Bad putenv type");
  len=strlen(value);
  if(type!=os_VARTYPE_LITERAL_STRING) len++;
                          /* Other types need null terminator! */
  e=xos_set_var_val(name,(byte*)value,len,0,type,0,0);
  if(e) return riscos_oserror();
  Py_INCREF(Py_None);
  return Py_None;
}

static PyObject *
riscos_delenv(PyObject *self, PyObject *args)
{
  char *name;
  if(!PyArg_ParseTuple(args,"s:delenv",&name)) return NULL;
  e=xos_set_var_val(name,NULL,-1,0,0,0,0);
  if(e) return riscos_oserror();
  Py_INCREF(Py_None);
  return Py_None;
}

static PyObject *
riscos_getenvdict(PyObject *self, PyObject *args)
{
  PyObject *dict;
  char value[257];
  char *which="*";
  int size;
  char *context=NULL;
  if(!PyArg_ParseTuple(args,"|s:getenvdict",&which)) return NULL;
  dict = PyDict_New();
  if (!dict) return NULL;
  /* XXX This part ignores errors */
  while(!xos_read_var_val(which,value,sizeof(value)-1,(int)context,
     os_VARTYPE_EXPANDED,&size,(int *)&context,0))
  { PyObject *v;
    value[size]='\0';
    v = PyString_FromString(value);
    if (v == NULL) continue;
    PyDict_SetItemString(dict, context, v);
    Py_DECREF(v);
  }
  return dict;
}

static PyMethodDef riscos_methods[] = {

    {"unlink",          riscos_remove, METH_VARARGS},
    {"remove",  riscos_remove, METH_VARARGS},
    {"rename",          riscos_rename, METH_VARARGS},
    {"system",          riscos_system, METH_VARARGS},
    {"rmdir",           riscos_remove, METH_VARARGS},
    {"chdir",           riscos_chdir,  METH_VARARGS},
    {"getcwd",          riscos_getcwd, METH_NOARGS},
    {"expand",  riscos_expand, METH_VARARGS},
    {"mkdir",           riscos_mkdir,  METH_VARARGS},
    {"listdir",         riscos_listdir, METH_VARARGS},
    {"stat",            riscos_stat,   METH_VARARGS},
    {"lstat",           riscos_stat,   METH_VARARGS},
    {"chmod",   riscos_chmod,  METH_VARARGS},
    {"utime",           riscos_utime,  METH_VARARGS},
    {"settype",         riscos_settype, METH_VARARGS},
    {"getenv",  riscos_getenv, METH_VARARGS},
    {"putenv",  riscos_putenv, METH_VARARGS},
    {"delenv",  riscos_delenv, METH_VARARGS},
    {"getenvdict", riscos_getenvdict, METH_VARARGS},
    {NULL,              NULL}            /* Sentinel */
};

static int
ins(PyObject *module, char *symbol, long value)
{
    return PyModule_AddIntConstant(module, symbol, value);
}


static int
all_ins(PyObject *d)
{
#ifdef F_OK
    if (ins(d, "F_OK", (long)F_OK)) return -1;
#endif
#ifdef R_OK
    if (ins(d, "R_OK", (long)R_OK)) return -1;
#endif
#ifdef W_OK
    if (ins(d, "W_OK", (long)W_OK)) return -1;
#endif
#ifdef X_OK
    if (ins(d, "X_OK", (long)X_OK)) return -1;
#endif
#ifdef NGROUPS_MAX
    if (ins(d, "NGROUPS_MAX", (long)NGROUPS_MAX)) return -1;
#endif
#ifdef TMP_MAX
    if (ins(d, "TMP_MAX", (long)TMP_MAX)) return -1;
#endif
#ifdef WCONTINUED
    if (ins(d, "WCONTINUED", (long)WCONTINUED)) return -1;
#endif
#ifdef WNOHANG
    if (ins(d, "WNOHANG", (long)WNOHANG)) return -1;
#endif
#ifdef WUNTRACED
    if (ins(d, "WUNTRACED", (long)WUNTRACED)) return -1;
#endif
#ifdef O_RDONLY
    if (ins(d, "O_RDONLY", (long)O_RDONLY)) return -1;
#endif
#ifdef O_WRONLY
    if (ins(d, "O_WRONLY", (long)O_WRONLY)) return -1;
#endif
#ifdef O_RDWR
    if (ins(d, "O_RDWR", (long)O_RDWR)) return -1;
#endif
#ifdef O_NDELAY
    if (ins(d, "O_NDELAY", (long)O_NDELAY)) return -1;
#endif
#ifdef O_NONBLOCK
    if (ins(d, "O_NONBLOCK", (long)O_NONBLOCK)) return -1;
#endif
#ifdef O_APPEND
    if (ins(d, "O_APPEND", (long)O_APPEND)) return -1;
#endif
#ifdef O_DSYNC
    if (ins(d, "O_DSYNC", (long)O_DSYNC)) return -1;
#endif
#ifdef O_RSYNC
    if (ins(d, "O_RSYNC", (long)O_RSYNC)) return -1;
#endif
#ifdef O_SYNC
    if (ins(d, "O_SYNC", (long)O_SYNC)) return -1;
#endif
#ifdef O_NOCTTY
    if (ins(d, "O_NOCTTY", (long)O_NOCTTY)) return -1;
#endif
#ifdef O_CREAT
    if (ins(d, "O_CREAT", (long)O_CREAT)) return -1;
#endif
#ifdef O_EXCL
    if (ins(d, "O_EXCL", (long)O_EXCL)) return -1;
#endif
#ifdef O_TRUNC
    if (ins(d, "O_TRUNC", (long)O_TRUNC)) return -1;
#endif
#ifdef O_BINARY
    if (ins(d, "O_BINARY", (long)O_BINARY)) return -1;
#endif
#ifdef O_TEXT
    if (ins(d, "O_TEXT", (long)O_TEXT)) return -1;
#endif
#ifdef O_LARGEFILE
    if (ins(d, "O_LARGEFILE", (long)O_LARGEFILE)) return -1;
#endif

/* MS Windows */
#ifdef O_NOINHERIT
    /* Don't inherit in child processes. */
    if (ins(d, "O_NOINHERIT", (long)O_NOINHERIT)) return -1;
#endif
#ifdef _O_SHORT_LIVED
    /* Optimize for short life (keep in memory). */
    /* MS forgot to define this one with a non-underscore form too. */
    if (ins(d, "O_SHORT_LIVED", (long)_O_SHORT_LIVED)) return -1;
#endif
#ifdef O_TEMPORARY
    /* Automatically delete when last handle is closed. */
    if (ins(d, "O_TEMPORARY", (long)O_TEMPORARY)) return -1;
#endif
#ifdef O_RANDOM
    /* Optimize for random access. */
    if (ins(d, "O_RANDOM", (long)O_RANDOM)) return -1;
#endif
#ifdef O_SEQUENTIAL
    /* Optimize for sequential access. */
    if (ins(d, "O_SEQUENTIAL", (long)O_SEQUENTIAL)) return -1;
#endif

/* GNU extensions. */
#ifdef O_DIRECT
    /* Direct disk access. */
    if (ins(d, "O_DIRECT", (long)O_DIRECT)) return -1;
#endif
#ifdef O_DIRECTORY
    /* Must be a directory.      */
    if (ins(d, "O_DIRECTORY", (long)O_DIRECTORY)) return -1;
#endif
#ifdef O_NOFOLLOW
    /* Do not follow links.      */
    if (ins(d, "O_NOFOLLOW", (long)O_NOFOLLOW)) return -1;
#endif

    /* These come from sysexits.h */
#ifdef EX_OK
    if (ins(d, "EX_OK", (long)EX_OK)) return -1;
#endif /* EX_OK */
#ifdef EX_USAGE
    if (ins(d, "EX_USAGE", (long)EX_USAGE)) return -1;
#endif /* EX_USAGE */
#ifdef EX_DATAERR
    if (ins(d, "EX_DATAERR", (long)EX_DATAERR)) return -1;
#endif /* EX_DATAERR */
#ifdef EX_NOINPUT
    if (ins(d, "EX_NOINPUT", (long)EX_NOINPUT)) return -1;
#endif /* EX_NOINPUT */
#ifdef EX_NOUSER
    if (ins(d, "EX_NOUSER", (long)EX_NOUSER)) return -1;
#endif /* EX_NOUSER */
#ifdef EX_NOHOST
    if (ins(d, "EX_NOHOST", (long)EX_NOHOST)) return -1;
#endif /* EX_NOHOST */
#ifdef EX_UNAVAILABLE
    if (ins(d, "EX_UNAVAILABLE", (long)EX_UNAVAILABLE)) return -1;
#endif /* EX_UNAVAILABLE */
#ifdef EX_SOFTWARE
    if (ins(d, "EX_SOFTWARE", (long)EX_SOFTWARE)) return -1;
#endif /* EX_SOFTWARE */
#ifdef EX_OSERR
    if (ins(d, "EX_OSERR", (long)EX_OSERR)) return -1;
#endif /* EX_OSERR */
#ifdef EX_OSFILE
    if (ins(d, "EX_OSFILE", (long)EX_OSFILE)) return -1;
#endif /* EX_OSFILE */
#ifdef EX_CANTCREAT
    if (ins(d, "EX_CANTCREAT", (long)EX_CANTCREAT)) return -1;
#endif /* EX_CANTCREAT */
#ifdef EX_IOERR
    if (ins(d, "EX_IOERR", (long)EX_IOERR)) return -1;
#endif /* EX_IOERR */
#ifdef EX_TEMPFAIL
    if (ins(d, "EX_TEMPFAIL", (long)EX_TEMPFAIL)) return -1;
#endif /* EX_TEMPFAIL */
#ifdef EX_PROTOCOL
    if (ins(d, "EX_PROTOCOL", (long)EX_PROTOCOL)) return -1;
#endif /* EX_PROTOCOL */
#ifdef EX_NOPERM
    if (ins(d, "EX_NOPERM", (long)EX_NOPERM)) return -1;
#endif /* EX_NOPERM */
#ifdef EX_CONFIG
    if (ins(d, "EX_CONFIG", (long)EX_CONFIG)) return -1;
#endif /* EX_CONFIG */
#ifdef EX_NOTFOUND
    if (ins(d, "EX_NOTFOUND", (long)EX_NOTFOUND)) return -1;
#endif /* EX_NOTFOUND */

    return 0;
}


void
initriscos()
{
    PyObject *m, *d, *stat_m;

    m = Py_InitModule("riscos", riscos_methods);

    if (all_ins(m))
        return;

    d = PyModule_GetDict(m);

    Py_INCREF(PyExc_OSError);
    PyModule_AddObject(m, "error", PyExc_OSError);

    PyStructSequence_InitType(&StatResultType, &stat_result_desc);
    PyDict_SetItemString(d, "stat_result", (PyObject*) &StatResultType);
}