cmd/lpsched/faults.c

/*
 * CDDL HEADER START
 *
 * The contents of this file are subject to the terms of the
 * Common Development and Distribution License (the "License").
 * You may not use this file except in compliance with the License.
 *
 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
 * or http://www.opensolaris.org/os/licensing.
 * See the License for the specific language governing permissions
 * and limitations under the License.
 *
 * When distributing Covered Code, include this CDDL HEADER in each
 * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
 * If applicable, add the following below this CDDL HEADER, with the
 * fields enclosed by brackets "[]" replaced with your own identifying
 * information: Portions Copyright [yyyy] [name of copyright owner]
 *
 * CDDL HEADER END
 */

/*
 * Copyright 2006 Sun Microsystems, Inc.  All rights reserved.
 * Use is subject to license terms.
 */

/*  Copyright (c) 1984, 1986, 1987, 1988, 1989 AT&T */
/*    All Rights Reserved   */


#pragma ident   "%Z%%M% %I% %E% SMI"
/* EMACS_MODES: !fill, lnumb, !overwrite, !nodelete, !picture */

#include "lpsched.h"
#include <syslog.h>

static char *
shortenReason(char *reason)
{
    register char   *ptr, *pe;
    int     peLen;

    if (strncmp(reason,"%%[",3) == 0)
        reason += 3;

    while (*reason == ' ')
        reason++;

    pe = "PrinterError:";
    peLen = strlen(pe);
    if (strncmp(reason,pe,peLen) == 0)
        reason += peLen;

    if (((ptr = strchr(reason,']')) != NULL) && (strncmp(ptr,"]%%",3) == 0))
        *ptr = 0;

    pe = reason + strlen(reason) -1;
    pe = reason;
    while (pe = strchr(pe,'\n'))
        *pe = ' ';

    pe = reason + strlen(reason) -1;
    while ((pe > reason) && (*pe == ' ')) {
        *pe = 0;
        pe--;
    }
    return(reason);
}

/**
 ** printer_fault() - RECOGNIZE PRINTER FAULT
 **/

void
printer_fault(register PSTATUS *pps, register RSTATUS *prs, char *alert_text,
     int err)
{
    register char       *why,*shortWhy;

    pps->status |= PS_FAULTED;

    /*  -F wait  */
    if (STREQU(pps->printer->fault_rec, NAME_WAIT))
        disable (pps, CUZ_FAULT, DISABLE_STOP);

    /*  -F beginning  */
    else if (STREQU(pps->printer->fault_rec, NAME_BEGINNING))
        terminate (pps->exec);

    /*  -F continue  AND  the interface program died  */
    else if (!(pps->status & PS_LATER) && !pps->request) {
        load_str (&pps->dis_reason, CUZ_STOPPED);
        schedule (EV_LATER, WHEN_PRINTER, EV_ENABLE, pps);
    }

    if (err) {
        errno = err;
        why = makestr(alert_text, "(", PERROR, ")\n", (char *)0);
    } else if (! alert_text)
        why = makestr("exec exit fault", (char *) 0);
    else
        why = makestr(alert_text, (char *) 0);

    if (!why)
        why = alert_text;

    shortWhy = (why != alert_text ? shortenReason(why) : why);

    load_str (&pps->fault_reason, shortWhy);
    dump_fault_status (pps);
    if (STREQU(pps->printer->fault_alert.shcmd,"show fault"))
        pps->status |= PS_SHOW_FAULT;
    else
        pps->status &= ~PS_SHOW_FAULT;

    note("printer fault. type: %s, status: %x\nmsg: (%s)\n",
        (pps->printer->fault_alert.shcmd ?
            pps->printer->fault_alert.shcmd : "??"),
        pps->status, shortWhy);

    if (pps->status & PS_SHOW_FAULT)
        schedule (EV_MESSAGE, pps);
    else {
        alert(A_PRINTER, pps, prs, shortWhy);
    }
    if (why != alert_text)
        Free (why);
}

/**
 ** clear_printer_fault() - RECOGNIZE PRINTER FAULT
 **/

void
clear_printer_fault(register PSTATUS *pps, char *alert_text)
{
    register char   *why, *shortWhy;

    pps->status &= ~PS_FAULTED;

    why = makestr(alert_text, (char *) 0);

    shortWhy = (why ? shortenReason(why) : alert_text);

    load_str (&pps->fault_reason, shortWhy);
    dump_fault_status (pps);
    if (STREQU(pps->printer->fault_alert.shcmd,"show fault"))
        pps->status |= PS_SHOW_FAULT;
    else
        pps->status &= ~PS_SHOW_FAULT;

    if (pps->status & PS_SHOW_FAULT)
        schedule (EV_MESSAGE, pps);
    if (why != alert_text)
        Free(why);
    schedule(EV_ENABLE, pps);
}

/**
 ** dial_problem() - ADDRESS DIAL-OUT PROBLEM
 **/

void
dial_problem(register PSTATUS *pps, RSTATUS *prs, int rc)
{
    static struct problem {
        char            *reason;
        int         retry_max,
                    dial_error;
    }           problems[] = {
        "DIAL FAILED",          10,  2, /* D_HUNG  */
        "CALLER SCRIPT FAILED",     10,  3, /* NO_ANS  */
        "CAN'T ACCESS DEVICE",       0,  6, /* L_PROB  */
        "DEVICE LOCKED",        20,  8, /* DV_NT_A */
        "NO DEVICES AVAILABLE",      0, 10, /* NO_BD_A */
        "SYSTEM NOT IN Systems FILE",    0, 13, /* BAD_SYS */
        "UNKNOWN dial() FAILURE",    0, 0
    };

    register struct problem *p;

    register char       *msg;

#define PREFIX  "Connect problem: "
#define SUFFIX  "This problem has occurred several times.\nPlease check the dialing instructions for this printer.\n"


    for (p = problems; p->dial_error; p++)
        if (p->dial_error == rc)
            break;

    if (!p->retry_max) {
        msg = Malloc(strlen(PREFIX) + strlen(p->reason) + 2);
        sprintf (msg, "%s%s\n", PREFIX, p->reason);
        printer_fault (pps, prs, msg, 0);
        Free (msg);

    } else if (pps->last_dial_rc != rc) {
        pps->nretry = 1;
        pps->last_dial_rc = (short)rc;

    } else if (pps->nretry++ > p->retry_max) {
        pps->nretry = 0;
        pps->last_dial_rc = (short)rc;
        msg = Malloc(
        strlen(PREFIX) + strlen(p->reason) + strlen(SUFFIX) + 2
        );
        sprintf (msg, "%s%s%s\n", PREFIX, p->reason, SUFFIX);
        printer_fault (pps, prs, msg, 0);
        Free (msg);
    }

    if (!(pps->status & PS_FAULTED)) {
        load_str (&pps->dis_reason, p->reason);
        schedule (EV_LATER, WHEN_PRINTER, EV_ENABLE, pps);
    }

    return;
}