* we have now several bstrs:
[citadel.git] / webcit / auth.c
index 40a390fb76ce1562888feb5379cc6930bf8c56ef..b2619691917252d1fd706b75aed4934f5fcacf2c 100644 (file)
@@ -1,38 +1,51 @@
 /*
  * $Id$
+ */
+/**
  *
- * Handles authentication of users to a Citadel server.
- *
+ * \defgroup WebcitAuth WebcitAuth; Handles authentication of users to a Citadel server.
+ * \ingroup CitadelConfig
  */
 
+/*@{*/
 #include "webcit.h"
 
-char *axdefs[7];
+
+
+/**
+ * \brief  user states
+ * the plain text states of a user. filled in at \ function TODO initialize_ax_defs()
+ * due to NLS
+ */
+char *axdefs[7]; 
 
 void initialize_axdefs(void) {
-       axdefs[0] = _("Deleted");
-       axdefs[1] = _("New User");
-       axdefs[2] = _("Problem User");
-       axdefs[3] = _("Local User");
-       axdefs[4] = _("Network User");
-       axdefs[5] = _("Preferred User");
-       axdefs[6] = _("Aide");
+       axdefs[0] = _("Deleted");       /*!0: an erased user */
+       axdefs[1] = _("New User");      /*!1: a new user */
+       axdefs[2] = _("Problem User");  /*!2: a trouble maker */
+       axdefs[3] = _("Local User");    /*!3: user with normal privileges */
+       axdefs[4] = _("Network User");  /*!4: a user that may access network resources */
+       axdefs[5] = _("Preferred User");/*!5: a moderator */
+       axdefs[6] = _("Aide");          /*!6: chief */
 }
 
 
-/*
- * Display the login screen
+
+
+/** 
+ * \brief Display the login screen
+ * \param mesg The error message if last attempt failed.
  */
 void display_login(char *mesg)
 {
        char buf[SIZ];
 
        output_headers(1, 1, 2, 0, 0, 0);
-       wprintf("<div style=\"position:absolute; top:20px; left:20px; right:20px\">\n");
+       wprintf("<div id=\"login_screen\">\n");
 
-       if (mesg != NULL) if (strlen(mesg) > 0) {
-               stresc(buf, mesg, 0, 0);
-               svprintf("mesg", WCS_STRING, "%s", buf);
+       if (mesg != NULL) if (!IsEmptyStr(mesg)) {
+                       stresc(buf, SIZ,  mesg, 0, 0);
+                       svprintf("mesg", WCS_STRING, "%s", buf);
        }
 
        svprintf("LOGIN_INSTRUCTIONS", WCS_STRING,
@@ -54,12 +67,22 @@ void display_login(char *mesg)
 
        svprintf("USERNAME_BOX", WCS_STRING, "%s", _("User name:"));
        svprintf("PASSWORD_BOX", WCS_STRING, "%s", _("Password:"));
+       svprintf("LANGUAGE_BOX", WCS_STRING, "%s", _("Language:"));
        svprintf("LOGIN_BUTTON", WCS_STRING, "%s", _("Login"));
        svprintf("NEWUSER_BUTTON", WCS_STRING, "%s", _("New User"));
        svprintf("EXIT_BUTTON", WCS_STRING, "%s", _("Exit"));
        svprintf("hello", WCS_SERVCMD, "MESG hello");
-       svprintf("BOXTITLE", WCS_STRING, _("%s - powered by Citadel"),
+       svprintf("BOXTITLE", WCS_STRING, _("%s - powered by <a href=\"http://www.citadel.org\">Citadel</a>"),
                serv_info.serv_humannode);
+       svcallback("DO_LANGUAGE_BOX", offer_languages);
+       if (serv_info.serv_newuser_disabled) {
+               svprintf("NEWUSER_BUTTON_PRE", WCS_STRING, "<div style=\"display:none;\">");
+               svprintf("NEWUSER_BUTTON_POST", WCS_STRING, "</div>");
+       }
+       else {
+               svprintf("NEWUSER_BUTTON_PRE", WCS_STRING, "");
+               svprintf("NEWUSER_BUTTON_POST", WCS_STRING, "");
+       }
 
        do_template("login");
 
@@ -69,19 +92,24 @@ void display_login(char *mesg)
 
 
 
-/*
+/** \brief Initialize the session
  * This function needs to get called whenever the session changes from
  * not-logged-in to logged-in, either by an explicit login by the user or
  * by a timed-out session automatically re-establishing with a little help
  * from the browser cookie.  Either way, we need to load access controls and
  * preferences from the server.
+ *
+ * \param user the username
+ * \param pass his password
+ * \param serv_response The parameters returned from a Citadel USER or NEWU command
  */
 void become_logged_in(char *user, char *pass, char *serv_response)
 {
        char buf[SIZ];
 
        WC->logged_in = 1;
-       extract_token(WC->wc_username, &serv_response[4], 0, '|', sizeof WC->wc_username);
+       extract_token(WC->wc_fullname, &serv_response[4], 0, '|', sizeof WC->wc_fullname);
+       safestrncpy(WC->wc_username, user, sizeof WC->wc_username);
        safestrncpy(WC->wc_password, pass, sizeof WC->wc_password);
        WC->axlevel = extract_int(&serv_response[4], 1);
        if (WC->axlevel >= 6) {
@@ -101,18 +129,29 @@ void become_logged_in(char *user, char *pass, char *serv_response)
 
        get_preference("current_iconbar", buf, sizeof buf);
        WC->current_iconbar = atoi(buf);
+
+       get_preference("floordiv_expanded", WC->floordiv_expanded, sizeof WC->floordiv_expanded);
 }
 
 
+/** 
+ * \brief Login Checks
+ * the logics to detect invalid passwords not to get on citservers nerves
+ */
 void do_login(void)
 {
        char buf[SIZ];
 
-       if (strlen(bstr("exit_action")) > 0) {
+       if (havebstr("language")) {
+               set_selected_language(bstr("language"));
+               go_selected_language();
+       }
+
+       if (havebstr("exit_action")) {
                do_logout();
                return;
        }
-       if (strlen(bstr("login_action")) > 0) {
+       if (havebstr("login_action")) {
                serv_printf("USER %s", bstr("name"));
                serv_getln(buf, sizeof buf);
                if (buf[0] == '3') {
@@ -130,8 +169,8 @@ void do_login(void)
                        return;
                }
        }
-       if (strlen(bstr("newuser_action")) > 0) {
-               if (strlen(bstr("pass")) == 0) {
+       if (havebstr("newuser_action")) {
+               if (!havebstr("pass")) {
                        display_login(_("Blank passwords are not allowed."));
                        return;
                }
@@ -158,6 +197,11 @@ void do_login(void)
 
 }
 
+/**
+ * \brief display the user a welcome screen. 
+ * if this is the first time login, and the web based setup is enabled, 
+ * lead the user through the setup routines
+ */
 void do_welcome(void)
 {
        char buf[SIZ];
@@ -165,14 +209,16 @@ void do_welcome(void)
        FILE *fp;
        int i;
 
-       /*
+       /**
         * See if we have to run the first-time setup wizard
         */
        if (WC->is_aide) {
                if (!setup_wizard) {
+                       int len;
                        sprintf(wizard_filename, "setupwiz.%s.%s",
                                ctdlhost, ctdlport);
-                       for (i=0; i<strlen(wizard_filename); ++i) {
+                       len = strlen(wizard_filename);
+                       for (i=0; i<len; ++i) {
                                if (    (wizard_filename[i]==' ')
                                        || (wizard_filename[i] == '/')
                                ) {
@@ -186,7 +232,7 @@ void do_welcome(void)
                                buf[strlen(buf)-1] = 0;
                                fclose(fp);
                                if (atoi(buf) == serv_info.serv_rev_level) {
-                                       setup_wizard = 1; /* already run */
+                                       setup_wizard = 1; /**< already run */
                                }
                        }
                }
@@ -197,11 +243,11 @@ void do_welcome(void)
        }
 #endif
 
-       /*
+       /**
         * Go to the user's preferred start page
         */
        get_preference("startpage", buf, sizeof buf);
-       if (strlen(buf)==0) {
+       if (IsEmptyStr(buf)) {
                safestrncpy(buf, "dotskip&room=_BASEROOM_", sizeof buf);
                set_preference("startpage", buf, 1);
        }
@@ -212,7 +258,7 @@ void do_welcome(void)
 }
 
 
-/*
+/**
  * Disconnect from the Citadel server, and end this WebCit session
  */
 void end_webcit_session(void) {
@@ -220,7 +266,8 @@ void end_webcit_session(void) {
 
        if (WC->logged_in) {
                sprintf(buf, "%d", WC->current_iconbar);
-               set_preference("current_iconbar", buf, 1);
+               set_preference("current_iconbar", buf, 0);
+               set_preference("floordiv_expanded", WC->floordiv_expanded, 1);
        }
 
        serv_puts("QUIT");
@@ -228,7 +275,9 @@ void end_webcit_session(void) {
        /* close() of citadel socket will be done by do_housekeeping() */
 }
 
-
+/** 
+ * execute the logout
+ */
 void do_logout(void)
 {
        char buf[SIZ];
@@ -236,11 +285,16 @@ void do_logout(void)
        safestrncpy(WC->wc_username, "", sizeof WC->wc_username);
        safestrncpy(WC->wc_password, "", sizeof WC->wc_password);
        safestrncpy(WC->wc_roomname, "", sizeof WC->wc_roomname);
+       safestrncpy(WC->wc_fullname, "", sizeof WC->wc_fullname);
 
-       /* Calling output_headers() this way causes the cookies to be un-set */
+       /** Calling output_headers() this way causes the cookies to be un-set */
        output_headers(1, 1, 0, 1, 0, 0);
 
-       wprintf("<center>");
+       wprintf("<div id=\"logout_screen\">");
+        wprintf("<div class=\"box\">");
+        wprintf("<div class=\"boxlabel\">");
+       wprintf(_("Log off"));
+        wprintf("</div><div class=\"boxcontent\">");   
        serv_puts("MESG goodbye");
        serv_getln(buf, sizeof buf);
 
@@ -256,18 +310,24 @@ void do_logout(void)
                        "connected to the Citadel server.  Please report "
                        "this problem to your system administrator.")
                );
+               wprintf("<a href=\"http://www.citadel.org/doku.php/"
+                       "faq:mastering_your_os:net#netstat\">%s</a>", 
+                       _("Read More..."));
        }
 
-       wprintf("<hr /><a href=\".\">Log in again</A>&nbsp;&nbsp;&nbsp;"
+       wprintf("<hr /><div class=\"buttons\"> "
+               "<span class=\"button_link\"><a href=\".\">");
+       wprintf(_("Log in again"));
+       wprintf("</a></span>&nbsp;&nbsp;&nbsp;<span class=\"button_link\">"
                "<a href=\"javascript:window.close();\">");
        wprintf(_("Close window"));
-       wprintf("</a></center>\n");
+       wprintf("</a></span></div></div></div></div>\n");
        wDumpContent(2);
        end_webcit_session();
 }
 
 
-/* 
+/* *
  * validate new users
  */
 void validate(void)
@@ -278,32 +338,44 @@ void validate(void)
        int a;
 
        output_headers(1, 1, 2, 0, 0, 0);
-       wprintf("<div id=\"banner\">\n"
-               "<TABLE WIDTH=100%% BORDER=0 BGCOLOR=\"#444455\"><TR><TD>"
-               "<SPAN CLASS=\"titlebar\">");
+       wprintf("<div id=\"banner\">\n");
+       wprintf("<h1>");
        wprintf(_("Validate new users"));
-       wprintf("</SPAN></TD></TR></TABLE>\n</div>\n<div id=\"content\">\n");
+       wprintf("</h1>");
+       wprintf("</div>\n");
+
+       wprintf("<div id=\"content\" class=\"service\">\n");
 
+       /** If the user just submitted a validation, process it... */
        safestrncpy(buf, bstr("user"), sizeof buf);
-       if (strlen(buf) > 0)
-               if (strlen(bstr("axlevel")) > 0) {
+       if (!IsEmptyStr(buf)) {
+               if (havebstr("axlevel")) {
                        serv_printf("VALI %s|%s", buf, bstr("axlevel"));
                        serv_getln(buf, sizeof buf);
                        if (buf[0] != '2') {
                                wprintf("<b>%s</b><br />\n", &buf[4]);
                        }
                }
+       }
+
+       /** Now see if any more users require validation. */
        serv_puts("GNUR");
        serv_getln(buf, sizeof buf);
-
+       if (buf[0] == '2') {
+               wprintf("<b>");
+               wprintf(_("No users require validation at this time."));
+               wprintf("</b><br />\n");
+               wDumpContent(1);
+               return;
+       }
        if (buf[0] != '3') {
                wprintf("<b>%s</b><br />\n", &buf[4]);
                wDumpContent(1);
                return;
        }
 
-       wprintf("<div id=\"fix_scrollbar_bug\">"
-               "<table border=0 width=100%% bgcolor=\"#ffffff\"><tr><td>\n");
+       wprintf("<div class=\"fix_scrollbar_bug\">"
+               "<table class=\"auth_validate\"><tr><td>\n");
        wprintf("<center>");
 
        safestrncpy(user, &buf[4], sizeof user);
@@ -315,7 +387,7 @@ void validate(void)
                        serv_getln(buf, sizeof buf);
                        ++a;
                        if (a == 1)
-                               wprintf("User #%s<br /><H1>%s</H1>",
+                               wprintf("#%s<br /><H1>%s</H1>",
                                        buf, &cmd[4]);
                        if (a == 2)
                                wprintf("PW: %s<br />\n", buf);
@@ -343,7 +415,7 @@ void validate(void)
        wprintf(_("Select access level for this user:"));
        wprintf("<br />\n");
        for (a = 0; a <= 6; ++a) {
-               wprintf("<a href=\"validate&user=");
+               wprintf("<a href=\"validate?nonce=%ld?user=", WC->nonce);
                urlescputs(user);
                wprintf("&axlevel=%d\">%s</A>&nbsp;&nbsp;&nbsp;\n",
                        a, axdefs[a]);
@@ -357,10 +429,11 @@ void validate(void)
 
 
 
-/* 
- * Display form for registration.
+/** 
+ * \brief Display form for registration.
  * (Set during_login to 1 if this registration is being performed during
  * new user login and will require chaining to the proper screen.)
+ * \param during_login are we just in the login phase?
  */
 void display_reg(int during_login)
 {
@@ -372,7 +445,7 @@ void display_reg(int during_login)
                return;
        }
 
-       vcard_msgnum = locate_user_vcard(WC->wc_username, -1);
+       vcard_msgnum = locate_user_vcard(WC->wc_fullname, -1);
        if (vcard_msgnum < 0L) {
                if (during_login) do_welcome();
                else display_main_menu();
@@ -380,10 +453,10 @@ void display_reg(int during_login)
        }
 
        if (during_login) {
-               do_edit_vcard(vcard_msgnum, "1", "do_welcome");
+               do_edit_vcard(vcard_msgnum, "1", "do_welcome", USERCONFIGROOM);
        }
        else {
-               do_edit_vcard(vcard_msgnum, "1", "display_main_menu");
+               do_edit_vcard(vcard_msgnum, "1", "display_main_menu", USERCONFIGROOM);
        }
 
 }
@@ -391,35 +464,24 @@ void display_reg(int during_login)
 
 
 
-/* 
+/** 
  * display form for changing your password
  */
 void display_changepw(void)
 {
        char buf[SIZ];
 
-       output_headers(1, 1, 2, 0, 0, 0);
-       wprintf("<div id=\"banner\">\n"
-               "<TABLE WIDTH=100%% BORDER=0 BGCOLOR=\"#444455\"><TR><TD>"
-               "<SPAN CLASS=\"titlebar\">");
-       wprintf(_("Change your password"));
-       wprintf("</SPAN>"
-               "</TD></TR></TABLE>\n"
-               "</div>\n<div id=\"content\">\n"
-       );
+       output_headers(1, 1, 1, 0, 0, 0);
+
+       svprintf("BOXTITLE", WCS_STRING, _("Change your password"));
+       do_template("beginbox");
 
-       if (strlen(WC->ImportantMessage) > 0) {
-               do_template("beginbox_nt");
-               wprintf("<SPAN CLASS=\"errormsg\">"
-                       "%s</SPAN><br />\n", WC->ImportantMessage);
-               do_template("endbox");
+       if (!IsEmptyStr(WC->ImportantMessage)) {
+               wprintf("<span class=\"errormsg\">"
+                       "%s</span><br />\n", WC->ImportantMessage);
                safestrncpy(WC->ImportantMessage, "", sizeof WC->ImportantMessage);
        }
 
-       wprintf("<div id=\"fix_scrollbar_bug\">"
-               "<table border=0 width=100%% bgcolor=\"#ffffff\"><tr><td>\n");
-
-       wprintf("<CENTER><br />");
        serv_puts("MESG changepw");
        serv_getln(buf, sizeof buf);
        if (buf[0] == '1') {
@@ -427,36 +489,39 @@ void display_changepw(void)
        }
 
        wprintf("<form name=\"changepwform\" action=\"changepw\" method=\"post\">\n");
-       wprintf("<CENTER>"
-               "<table border=\"0\" cellspacing=\"5\" cellpadding=\"5\" "
-               "BGCOLOR=\"#EEEEEE\">"
-               "<TR><TD>");
+       wprintf("<input type=\"hidden\" name=\"nonce\" value=\"%ld\">\n", WC->nonce);
+       wprintf("<table class=\"altern\" ");
+       wprintf("<tr class=\"even\"><td>");
        wprintf(_("Enter new password:"));
-       wprintf("</TD>\n");
-       wprintf("<TD><INPUT TYPE=\"password\" NAME=\"newpass1\" VALUE=\"\" MAXLENGTH=\"20\"></TD></TR>\n");
-       wprintf("<TR><TD>");
+       wprintf("</td><td>");
+       wprintf("<input type=\"password\" name=\"newpass1\" value=\"\" maxlength=\"20\"></td></tr>\n");
+       wprintf("<tr class=\"odd\"><td>");
        wprintf(_("Enter it again to confirm:"));
-       wprintf("</TD>\n");
-       wprintf("<TD><INPUT TYPE=\"password\" NAME=\"newpass2\" VALUE=\"\" MAXLENGTH=\"20\"></TD></TR>\n");
+       wprintf("</td><td>");
+       wprintf("<input type=\"password\" name=\"newpass2\" value=\"\" maxlength=\"20\"></td></tr>\n");
+       wprintf("</table>\n");
 
-       wprintf("</TABLE><br />\n");
-       wprintf("<INPUT type=\"submit\" name=\"change_action\" value=\"%s\">", _("Change password"));
+       wprintf("<div class=\"buttons\">\n");
+       wprintf("<input type=\"submit\" name=\"change_action\" value=\"%s\">", _("Change password"));
        wprintf("&nbsp;");
-       wprintf("<INPUT type=\"submit\" name=\"cancel_action\" value=\"%s\">\n", _("Cancel"));
-       wprintf("</form></center>\n");
-       wprintf("</td></tr></table></div>\n");
+       wprintf("<input type=\"submit\" name=\"cancel_action\" value=\"%s\">\n", _("Cancel"));
+       wprintf("</div>\n");
+       wprintf("</form>\n");
+
+       do_template("endbox");
        wDumpContent(1);
 }
 
-/*
- * change password
+/**
+ * \brief change password
+ * if passwords match, propagate it to citserver.
  */
 void changepw(void)
 {
        char buf[SIZ];
        char newpass1[32], newpass2[32];
 
-       if (strlen(bstr("change_action")) == 0) {
+       if (!havebstr("change_action")) {
                safestrncpy(WC->ImportantMessage, 
                        _("Cancelled.  Password was not changed."),
                        sizeof WC->ImportantMessage);
@@ -475,7 +540,7 @@ void changepw(void)
                return;
        }
 
-       if (strlen(newpass1) == 0) {
+       if (IsEmptyStr(newpass1)) {
                safestrncpy(WC->ImportantMessage, 
                        _("Blank passwords are not allowed."),
                        sizeof WC->ImportantMessage);
@@ -494,3 +559,7 @@ void changepw(void)
                display_changepw();
        }
 }
+
+
+
+/** @} */