cmd-misc.c

   1 /*@ S-nail - a mail user agent derived from Berkeley Mail.
   2  *@ Miscellaneous user commands, like `echo', `pwd', etc.
   3  *
   4  * Copyright (c) 2000-2004 Gunnar Ritter, Freiburg i. Br., Germany.
   5  * Copyright (c) 2012 - 2017 Steffen (Daode) Nurpmeso <steffen@sdaoden.eu>.
   6  */
   7 /*
   8  * Copyright (c) 1980, 1993
   9  *      The Regents of the University of California.  All rights reserved.
  10  *
  11  * Redistribution and use in source and binary forms, with or without
  12  * modification, are permitted provided that the following conditions
  13  * are met:
  14  * 1. Redistributions of source code must retain the above copyright
  15  *    notice, this list of conditions and the following disclaimer.
  16  * 2. Redistributions in binary form must reproduce the above copyright
  17  *    notice, this list of conditions and the following disclaimer in the
  18  *    documentation and/or other materials provided with the distribution.
  19  * 3. Neither the name of the University nor the names of its contributors
  20  *    may be used to endorse or promote products derived from this software
  21  *    without specific prior written permission.
  22  *
  23  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  24  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  25  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  26  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  27  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  28  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  29  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  30  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  31  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  32  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  33  * SUCH DAMAGE.
  34  */
  35 #undef n_FILE
  36 #define n_FILE cmd_misc
  37
  38 #ifndef HAVE_AMALGAMATION
  39 # include "nail.h"
  40 #endif
  41
  42 /* Expand the shell escape by expanding unescaped !'s into the last issued
  43  * command where possible */
  44 static char const *a_cmisc_bangexp(char const *cp);
  45
  46 /* c_n?echo(), c_n?echoerr() */
  47 static int a_cmisc_echo(void *vp, FILE *fp, bool_t donl);
  48
  49 /* c_read() */
  50 static bool_t a_cmisc_read_set(char const *cp, char const *value);
  51
  52 /* c_version() */
  53 static int a_cmisc_version_cmp(void const *s1, void const *s2);
  54
  55 static char const *
  56 a_cmisc_bangexp(char const *cp){
  57    static struct str last_bang;
  58
  59    struct n_string xbang, *bang;
  60    char c;
  61    bool_t changed;
  62    NYD_ENTER;
  63
  64    if(!ok_blook(bang))
  65       goto jleave;
  66
  67    changed = FAL0;
  68
  69    for(bang = n_string_creat(&xbang); (c = *cp++) != '\0';){
  70       if(c == '!'){
  71          if(last_bang.l > 0)
  72             bang = n_string_push_buf(bang, last_bang.s, last_bang.l);
  73          changed = TRU1;
  74       }else{
  75          if(c == '\\' && *cp == '!'){
  76             ++cp;
  77             c = '!';
  78             changed = TRU1;
  79          }
  80          bang = n_string_push_c(bang, c);
  81       }
  82    }
  83
  84    if(last_bang.s != NULL)
  85       free(last_bang.s);
  86    last_bang.s = n_string_cp(bang);
  87    last_bang.l = bang->s_len;
  88    bang = n_string_drop_ownership(bang);
  89    n_string_gut(bang);
  90
  91    cp = last_bang.s;
  92    if(changed)
  93       fprintf(n_stdout, "!%s\n", cp);
  94 jleave:
  95    NYD_LEAVE;
  96    return cp;
  97 }
  98
  99 static int
 100 a_cmisc_echo(void *vp, FILE *fp, bool_t donl){
 101    char const **argv, **ap, *cp;
 102    int rv;
 103    bool_t doerr;
 104    NYD2_ENTER;
 105
 106 #ifdef HAVE_ERRORS
 107    doerr = (fp == n_stderr &&  (n_psonce & n_PSO_INTERACTIVE));
 108 #else
 109    doerr = FAL0;
 110 #endif
 111
 112    for(ap = argv = vp; *ap != NULL; ++ap){
 113       if(ap != argv){
 114          if(doerr)
 115             n_err(" ");
 116          else
 117             putc(' ', fp);
 118       }
 119       if((cp = fexpand(*ap, FEXP_NSHORTCUT | FEXP_NVAR)) == NULL)
 120          cp = *ap;
 121       if(doerr)
 122          n_err(cp);
 123       else
 124          fputs(cp, fp);
 125    }
 126    if(donl){
 127       if(doerr)
 128          n_err("\n");
 129       else
 130          putc('\n', fp);
 131    }
 132
 133    rv = (fflush(fp) == EOF);
 134    rv |= ferror(fp) ? 1 : 0;
 135    NYD2_LEAVE;
 136    return rv;
 137 }
 138
 139 static bool_t
 140 a_cmisc_read_set(char const *cp, char const *value){
 141    bool_t rv;
 142    NYD2_ENTER;
 143
 144    if(!n_shexp_is_valid_varname(cp))
 145       value = N_("not a valid variable name");
 146    else if(!n_var_is_user_writable(cp))
 147       value = N_("variable is read-only");
 148    else if(!n_var_vset(cp, (uintptr_t)value))
 149       value = N_("failed to update variable value");
 150    else{
 151       rv = TRU1;
 152       goto jleave;
 153    }
 154    n_err("`read': %s: %s\n", V_(value), n_shexp_quote_cp(cp, FAL0));
 155    rv = FAL0;
 156 jleave:
 157    NYD2_LEAVE;
 158    return rv;
 159 }
 160
 161 static int
 162 a_cmisc_version_cmp(void const *s1, void const *s2){
 163    char const * const *cp1, * const *cp2;
 164    int rv;
 165    NYD2_ENTER;
 166
 167    cp1 = s1;
 168    cp2 = s2;
 169    rv = strcmp(&(*cp1)[1], &(*cp2)[1]);
 170    NYD2_LEAVE;
 171    return rv;
 172 }
 173
 174 FL int
 175 c_sleep(void *v){
 176    uiz_t sec, msec;
 177    char **argv;
 178    NYD_ENTER;
 179
 180    argv = v;
 181
 182    if((n_idec_uiz_cp(&sec, argv[0], 0, NULL) &
 183          (n_IDEC_STATE_EMASK | n_IDEC_STATE_CONSUMED)
 184          ) != n_IDEC_STATE_CONSUMED)
 185       goto jesyn;
 186
 187    if(argv[1] == NULL)
 188       msec = 0;
 189    else if((n_idec_uiz_cp(&msec, argv[1], 0, NULL) &
 190          (n_IDEC_STATE_EMASK | n_IDEC_STATE_CONSUMED)
 191          ) != n_IDEC_STATE_CONSUMED)
 192       goto jesyn;
 193
 194    if(UIZ_MAX / n_DATE_MILLISSEC < sec)
 195       goto jeover;
 196    sec *= n_DATE_MILLISSEC;
 197
 198    if(UIZ_MAX - sec < msec)
 199       goto jeover;
 200    msec += sec;
 201
 202    n_pstate_err_no = (n_msleep(msec, (argv[2] == NULL)) > 0)
 203          ? n_ERR_INTR : n_ERR_NONE;
 204 jleave:
 205    NYD_LEAVE;
 206    return (argv == NULL);
 207 jeover:
 208    n_err(_("`sleep': argument(s) overflow(s) datatype\n"));
 209    n_pstate_err_no = n_ERR_OVERFLOW;
 210    argv = NULL;
 211    goto jleave;
 212 jesyn:
 213    n_err(_("Synopsis: sleep: <seconds> [<milliseconds>] [uninterruptible]\n"));
 214    n_pstate_err_no = n_ERR_INVAL;
 215    argv = NULL;
 216    goto jleave;
 217 }
 218
 219 FL int
 220 c_shell(void *v)
 221 {
 222    sigset_t mask;
 223    int rv;
 224    FILE *fp;
 225    char const **argv, *varname, *varres, *cp;
 226    NYD_ENTER;
 227
 228    n_pstate_err_no = n_ERR_NONE;
 229    argv = v;
 230    varname = (n_pstate & n_PS_ARGMOD_VPUT) ? *argv++ : NULL;
 231    varres = n_empty;
 232    fp = NULL;
 233
 234    if(varname != NULL &&
 235          (fp = Ftmp(NULL, "shell", OF_RDWR | OF_UNLINK | OF_REGISTER)
 236             ) == NULL){
 237       n_pstate_err_no = n_ERR_CANCELED;
 238       rv = -1;
 239    }else{
 240       cp = a_cmisc_bangexp(*argv);
 241
 242       sigemptyset(&mask);
 243       if(n_child_run(ok_vlook(SHELL), &mask,
 244             n_CHILD_FD_PASS, (fp != NULL ? fileno(fp) : n_CHILD_FD_PASS),
 245             "-c", cp, NULL, NULL, &rv) < 0){
 246          n_pstate_err_no = n_err_no;
 247          rv = -1;
 248       }else{
 249          rv = WEXITSTATUS(rv);
 250
 251          if(fp != NULL){
 252             int c;
 253             char *x;
 254             off_t l;
 255
 256             fflush_rewind(fp);
 257             l = fsize(fp);
 258             if(UICMP(64, l, >=, UIZ_MAX -42)){
 259                n_pstate_err_no = n_ERR_NOMEM;
 260                varres = n_empty;
 261             }else{
 262                varres = x = n_autorec_alloc(l +1);
 263
 264                for(; l > 0 && (c = getc(fp)) != EOF; --l)
 265                   *x++ = c;
 266                *x++ = '\0';
 267                if(l != 0){
 268                   n_pstate_err_no = n_err_no;
 269                   varres = n_empty; /* xxx hmmm */
 270                }
 271             }
 272          }
 273       }
 274    }
 275
 276    if(fp != NULL)
 277       Fclose(fp);
 278
 279    if(varname != NULL){
 280       if(!n_var_vset(varname, (uintptr_t)varres)){
 281          n_pstate_err_no = n_ERR_NOTSUP;
 282          rv = -1;
 283       }
 284    }else if(rv >= 0){
 285       fprintf(n_stdout, "!\n");
 286       /* Line buffered fflush(n_stdout); */
 287    }
 288    NYD_LEAVE;
 289    return rv;
 290 }
 291
 292 FL int
 293 c_dosh(void *v)
 294 {
 295    int rv;
 296    NYD_ENTER;
 297    n_UNUSED(v);
 298
 299    if(n_child_run(ok_vlook(SHELL), 0, n_CHILD_FD_PASS, n_CHILD_FD_PASS, NULL,
 300          NULL, NULL, NULL, &rv) < 0){
 301       n_pstate_err_no = n_err_no;
 302       rv = -1;
 303    }else{
 304       putc('\n', n_stdout);
 305       /* Line buffered fflush(n_stdout); */
 306       n_pstate_err_no = n_ERR_NONE;
 307       rv = WEXITSTATUS(rv);
 308    }
 309    NYD_LEAVE;
 310    return rv;
 311 }
 312
 313 FL int
 314 c_cwd(void *v){
 315    struct n_string s_b, *sp;
 316    size_t l;
 317    char const *varname;
 318    NYD_ENTER;
 319
 320    sp = n_string_creat_auto(&s_b);
 321    varname = (n_pstate & n_PS_ARGMOD_VPUT) ? *(char const**)v : NULL;
 322    l = PATH_MAX;
 323
 324    for(;; l += PATH_MAX){
 325       sp = n_string_resize(n_string_trunc(sp, 0), l);
 326
 327       if(getcwd(sp->s_dat, sp->s_len) == NULL){
 328          int e;
 329
 330          e = n_err_no;
 331          if(e == n_ERR_RANGE)
 332             continue;
 333          n_perr(_("Failed to getcwd(3)"), e);
 334          v = NULL;
 335          break;
 336       }
 337
 338       if(varname != NULL){
 339          if(!n_var_vset(varname, (uintptr_t)sp->s_dat))
 340             v = NULL;
 341       }else{
 342          l = strlen(sp->s_dat);
 343          sp = n_string_trunc(sp, l);
 344          if(fwrite(sp->s_dat, 1, sp->s_len, n_stdout) == sp->s_len &&
 345                putc('\n', n_stdout) == EOF)
 346             v = NULL;
 347       }
 348       break;
 349    }
 350    NYD_LEAVE;
 351    return (v == NULL);
 352 }
 353
 354 FL int
 355 c_chdir(void *v)
 356 {
 357    char **arglist = v;
 358    char const *cp;
 359    NYD_ENTER;
 360
 361    if (*arglist == NULL)
 362       cp = ok_vlook(HOME);
 363    else if ((cp = fexpand(*arglist, FEXP_LOCAL | FEXP_NOPROTO)) == NULL)
 364       goto jleave;
 365    if (chdir(cp) == -1) {
 366       n_perr(cp, 0);
 367       cp = NULL;
 368    }
 369 jleave:
 370    NYD_LEAVE;
 371    return (cp == NULL);
 372 }
 373
 374 FL int
 375 c_echo(void *v){
 376    int rv;
 377    NYD_ENTER;
 378
 379    rv = a_cmisc_echo(v, n_stdout, TRU1);
 380    NYD_LEAVE;
 381    return rv;
 382 }
 383
 384 FL int
 385 c_echoerr(void *v){
 386    int rv;
 387    NYD_ENTER;
 388
 389    rv = a_cmisc_echo(v, n_stderr, TRU1);
 390    NYD_LEAVE;
 391    return rv;
 392 }
 393
 394 FL int
 395 c_echon(void *v){
 396    int rv;
 397    NYD_ENTER;
 398
 399    rv = a_cmisc_echo(v, n_stdout, FAL0);
 400    NYD_LEAVE;
 401    return rv;
 402 }
 403
 404 FL int
 405 c_echoerrn(void *v){
 406    int rv;
 407    NYD_ENTER;
 408
 409    rv = a_cmisc_echo(v, n_stderr, FAL0);
 410    NYD_LEAVE;
 411    return rv;
 412 }
 413
 414 FL int
 415 c_read(void * volatile vp){
 416    struct n_sigman sm;
 417    struct str trim;
 418    struct n_string s, *sp;
 419    char *linebuf;
 420    size_t linesize, i;
 421    int rv;
 422    char const *ifs, **argv, *cp;
 423    NYD2_ENTER;
 424
 425    sp = n_string_creat_auto(&s);
 426    sp = n_string_reserve(sp, 64 -1);
 427
 428    ifs = ok_vlook(ifs);
 429    rv = 0;
 430    linesize = 0;
 431    linebuf = NULL;
 432    argv = vp;
 433
 434    n_SIGMAN_ENTER_SWITCH(&sm, n_SIGMAN_ALL){
 435    case 0:
 436       break;
 437    default:
 438       n_pstate_err_no = n_ERR_INTR;
 439       rv = -1;
 440       goto jleave;
 441    }
 442
 443    n_pstate_err_no = n_ERR_NONE;
 444    rv = n_go_input(((n_pstate & n_PS_COMPOSE_MODE
 445             ? n_GO_INPUT_CTX_COMPOSE : n_GO_INPUT_CTX_DEFAULT) |
 446          n_GO_INPUT_FORCE_STDIN | n_GO_INPUT_NL_ESC |
 447          n_GO_INPUT_PROMPT_NONE /* XXX POSIX: PS2: yes! */),
 448          NULL, &linebuf, &linesize, NULL, NULL);
 449    if(rv < 0){
 450       if(!n_go_input_is_eof())
 451          n_pstate_err_no = n_ERR_BADF;
 452       goto jleave;
 453    }else if(rv == 0){
 454       if(n_go_input_is_eof()){
 455          rv = -1;
 456          goto jleave;
 457       }
 458    }else{
 459       trim.s = linebuf;
 460       trim.l = linesize;
 461
 462       for(; *argv != NULL; ++argv){
 463          if(trim.l == 0 || n_str_trim_ifs(&trim, FAL0)->l == 0)
 464             break;
 465
 466          /* The last variable gets the remaining line less trailing IFS-WS */
 467          if(argv[1] == NULL){
 468 jitall:
 469             sp = n_string_assign_buf(sp, trim.s, trim.l);
 470             trim.l = 0;
 471          }else for(cp = trim.s, i = 1;; ++cp, ++i){
 472             if(strchr(ifs, *cp) != NULL){
 473                sp = n_string_assign_buf(sp, trim.s, i - 1);
 474                trim.s += i;
 475                trim.l -= i;
 476                break;
 477             }
 478             if(i == trim.l)
 479                goto jitall;
 480          }
 481
 482          if(!a_cmisc_read_set(*argv, n_string_cp(sp))){
 483             n_pstate_err_no = n_ERR_NOTSUP;
 484             rv = -1;
 485             break;
 486          }
 487       }
 488    }
 489
 490    /* Set the remains to the empty string */
 491 jleave:
 492    for(; *argv != NULL; ++argv)
 493       if(!a_cmisc_read_set(*argv, n_empty)){
 494          n_pstate_err_no = n_ERR_NOTSUP;
 495          rv = -1;
 496          break;
 497       }
 498
 499    n_sigman_cleanup_ping(&sm);
 500
 501    if(linebuf != NULL)
 502       n_free(linebuf);
 503    NYD2_LEAVE;
 504    n_sigman_leave(&sm, n_SIGMAN_VIPSIGS_NTTYOUT);
 505    return rv;
 506 }
 507
 508 FL int
 509 c_version(void *vp){
 510    int longest, rv;
 511    char *iop;
 512    char const *cp, **arr;
 513    size_t i, i2;
 514    NYD_ENTER;
 515    n_UNUSED(vp);
 516
 517    fprintf(n_stdout,
 518       _("%s %s, %s (%s)\nFeatures included (+) or not (-)\n"),
 519       n_uagent, ok_vlook(version), ok_vlook(version_date),
 520       ok_vlook(build_osenv));
 521
 522    /* *features* starts with dummy byte to avoid + -> *folder* expansions */
 523    i = strlen(cp = &ok_vlook(features)[1]) +1;
 524    iop = n_autorec_alloc(i);
 525    memcpy(iop, cp, i);
 526
 527    arr = n_autorec_alloc(sizeof(cp) * VAL_FEATURES_CNT);
 528    for(longest = 0, i = 0; (cp = n_strsep(&iop, ',', TRU1)) != NULL; ++i){
 529       arr[i] = cp;
 530       i2 = strlen(cp);
 531       longest = n_MAX(longest, (int)i2);
 532    }
 533    qsort(arr, i, sizeof(cp), &a_cmisc_version_cmp);
 534
 535    /* We use aligned columns, so don't use n_SCRNWIDTH_FOR_LISTS */
 536    for(++longest, i2 = 0; i-- > 0;){
 537       cp = *(arr++);
 538       fprintf(n_stdout, "%-*s ", longest, cp);
 539       i2 += longest;
 540       if(UICMP(z, ++i2 + longest, >=, n_scrnwidth) || i == 0){
 541          i2 = 0;
 542          putc('\n', n_stdout);
 543       }
 544    }
 545
 546    if((rv = ferror(n_stdout) != 0))
 547       clearerr(n_stdout);
 548    NYD_LEAVE;
 549    return rv;
 550 }
 551
 552 /* s-it-mode */