* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
- *
- * $Id$
*/
+/** @file
+ * @brief Implementation of functions to send common replies to users.
+ * @version $Id$
+ */
+#include "config.h"
+
#include "ircd_reply.h"
#include "client.h"
#include "ircd.h"
+#include "ircd_log.h"
+#include "ircd_snprintf.h"
+#include "msg.h"
+#include "msgq.h"
#include "numeric.h"
#include "s_conf.h"
#include "s_debug.h"
#include "send.h"
-#include <assert.h>
+/* #include <assert.h> -- Now using assert in ircd_log.h */
+#include <string.h>
-int need_more_params(struct Client* cptr, const char* cmd)
+/** Report a protocol violation warning to anyone listening. This can
+ * be easily used to clean up the last couple of parts of the code.
+ * @param[in] cptr Client that violated the protocol.
+ * @param[in] pattern Description of how the protocol was violated.
+ * @return Zero.
+ */
+int protocol_violation(struct Client* cptr, const char* pattern, ...)
{
- sendto_one(cptr, err_str(ERR_NEEDMOREPARAMS),
- me.name, (*cptr->name) ? cptr->name : "*", cmd);
+ struct VarData vd;
+ char message[BUFSIZE];
+
+ assert(pattern);
+ assert(cptr);
+
+ vd.vd_format = pattern;
+ va_start(vd.vd_args, pattern);
+ ircd_snprintf(NULL, message, sizeof(message),
+ "Protocol Violation from %s: %v", cli_name(cptr), &vd);
+ va_end(vd.vd_args);
+
+ sendwallto_group_butone(&me, WALL_DESYNCH, NULL, "%s", message);
return 0;
}
-/*
- * send_error_to_client - send an error message to a client
- * I don't know if this function is any faster than the other version
- * but it is a bit easier to use. It's reentrant until it hits vsendto_one
- * at least :) --Bleep
+/** Inform a client that they need to provide more parameters.
+ * @param[in] cptr Taciturn client.
+ * @param[in] cmd Command name.
+ * @return Zero.
*/
-int send_error_to_client(struct Client* cptr, int error, ...)
+int need_more_params(struct Client* cptr, const char* cmd)
{
- va_list vl;
- char buf[BUFSIZE];
- char* dest = buf;
- const char* src = me.name;
- const struct Numeric* num = get_error_numeric(error);
-
- assert(0 != cptr);
- assert(0 != num);
- /*
- * prefix
- */
- *dest++ = ':';
- while ((*dest = *src++))
- ++dest;
- *dest++ = ' ';
- /*
- * numeric
- */
- src = num->str;
- while ((*dest = *src++))
- ++dest;
- *dest++ = ' ';
- /*
- * client name (nick)
- */
- src = cptr->name;
- while ((*dest = *src++))
- ++dest;
- *dest++ = ' ';
- /*
- * reply format
- */
- strcpy(dest, num->format);
-
-#if 0
- Debug((DEBUG_INFO, "send_error_to_client: format: ->%s<-", buf));
-#endif
-
- va_start(vl, error);
- vsendto_one(cptr, buf, vl);
- va_end(vl);
+ send_reply(cptr, ERR_NEEDMOREPARAMS, cmd);
return 0;
}
-int send_admin_info(struct Client* sptr, const struct ConfItem* admin)
+/** Send a generic reply to a user.
+ * @param[in] to Client that wants a reply.
+ * @param[in] reply Numeric of message to send.
+ * @return Zero.
+ */
+int send_reply(struct Client *to, int reply, ...)
{
- assert(0 != sptr);
- if (admin) {
- sendto_one(sptr, rpl_str(RPL_ADMINME), me.name, sptr->name, me.name);
- sendto_one(sptr, rpl_str(RPL_ADMINLOC1), me.name, sptr->name, admin->host);
- sendto_one(sptr, rpl_str(RPL_ADMINLOC2), me.name, sptr->name, admin->passwd);
- sendto_one(sptr, rpl_str(RPL_ADMINEMAIL), me.name, sptr->name, admin->name);
- }
+ struct VarData vd;
+ struct MsgBuf *mb;
+ const struct Numeric *num;
+
+ assert(0 != to);
+ assert(0 != reply);
+
+ num = get_error_numeric(reply & ~SND_EXPLICIT); /* get reply... */
+
+ va_start(vd.vd_args, reply);
+
+ if (reply & SND_EXPLICIT) /* get right pattern */
+ vd.vd_format = (const char *) va_arg(vd.vd_args, char *);
else
- send_error_to_client(sptr, ERR_NOADMININFO, me.name);
- return 0;
+ vd.vd_format = num->format;
+
+ assert(0 != vd.vd_format);
+
+ /* build buffer */
+ mb = msgq_make(cli_from(to), "%:#C %s %C %v", &me, num->str, to, &vd);
+
+ va_end(vd.vd_args);
+
+ /* send it to the user */
+ send_buffer(to, mb, 0);
+
+ msgq_clean(mb);
+
+ return 0; /* convenience return */
}
+