trivial doxygen cleanups
[paraslash.git] / random_selector.c
index a90822c..bef1b7f 100644 (file)
@@ -1,19 +1,7 @@
 /*
- * Copyright (C) 2004-2006 Andre Noll <maan@systemlinux.org>
+ * Copyright (C) 2004-2007 Andre Noll <maan@systemlinux.org>
  *
- *     This program is free software; you can redistribute it and/or modify
- *     it under the terms of the GNU General Public License as published by
- *     the Free Software Foundation; either version 2 of the License, or
- *     (at your option) any later version.
- *
- *     This program is distributed in the hope that it will be useful,
- *     but WITHOUT ANY WARRANTY; without even the implied warranty of
- *     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- *     GNU General Public License for more details.
- *
- *     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., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
+ * Licensed under the GPL v2. For licencing details see COPYING.
  */
 
 /** \file random_selector.c An audio file selector which chooses files by random */
 #include <sys/time.h> /* gettimeofday */
 #include "server.cmdline.h"
 #include "server.h"
-#include "db.h"
+#include "afs.h"
 #include "error.h"
 #include "net.h"
 #include "string.h"
+#include "random_selector_command_list.h"
 
-static int com_random_info(int, int, char **);
-extern struct gengetopt_args_info conf;
 extern struct misc_meta_data *mmd;
 
 static unsigned int num_audio_files, audio_file_count;
@@ -41,30 +28,15 @@ static int count_audio_files(__a_unused const char *dir, __a_unused const char *
 
 static int remember_file(const char *dir, const char *name)
 {
-       if (audio_file_count >= num_audio_files)
-               return -E_FILE_COUNT;
-       audio_file_list[audio_file_count] = make_message("%s/%s", dir, name);
-       audio_file_count++;
+       if (audio_file_count < num_audio_files) {
+               audio_file_list[audio_file_count] =
+                       make_message("%s/%s", dir, name);
+               audio_file_count++;
+       }
        return 1;
 }
 
-/* array of commands that are supported by this selector */
-static struct server_command cmds[] = {
-{
-.name = "random_info",
-.handler = com_random_info,
-.perms = 0,
-.description = "about the random audio file selector",
-.synopsis = "random_info",
-.help =
-
-"Select a random file under the given directory"
-}, {
-.name = NULL,
-}
-};
-
-static int com_random_info(int fd, __a_unused int argc, __a_unused char *argv[])
+int com_random_info(int fd, __a_unused int argc, __a_unused char *argv[])
 {
        return send_buffer(fd, "Don't use for huge directories as it is "
                "very inefficient in this case.\n");
@@ -98,7 +70,7 @@ static char **random_get_audio_file_list(unsigned int num)
                goto out;
        /* careful, files might got deleted underneath */
        num_audio_files = audio_file_count; /* can only decrease */
-       len = MIN(num, num_audio_files);
+       len = PARA_MIN(num, num_audio_files);
        ret = -E_NOTHING_FOUND;
        if (!len) /* nothing found, return NULL */
                goto out;
@@ -109,40 +81,59 @@ static char **random_get_audio_file_list(unsigned int num)
                        / (RAND_MAX + 1.0)));
                ret_list[i] = para_strdup(audio_file_list[r]);
        }
+       ret = 1;
 out:
        if (audio_file_list) {
                for (i = 0; i < num_audio_files; i++)
                        free(audio_file_list[i]);
                free(audio_file_list);
        }
-//     if (ret < 0)
-//             PARA_ERROR_LOG("%s\n", PARA_STRERROR(-ret));
+       if (ret > 0) {
+       } else
+               sprintf(mmd->selector_info, "dbinfo1:%s\n", PARA_STRERROR(-ret));
        return ret_list;
 }
 
+static void random_update_audio_file(char *audio_file)
+{
+       char *dn = para_dirname(audio_file);
+       snprintf(mmd->selector_info, MMD_INFO_SIZE - 1,
+               "dbinfo1:current dir: %s\n"
+               "dbinfo2:random_dir: %s\n"
+               "dbinfo3:%d files available\n",
+               dn, conf.random_dir_arg, num_audio_files);
+       free(dn);
+       mmd->selector_info[MMD_INFO_SIZE - 1] = '\0';
+}
 static void random_shutdown(void)
 {
 }
 
 /**
- *  the init function for the random audio file selector
+ * the init function for the random audio file selector
+ *
+ * \param s pointer ro the struct to iniitalize
  *
- * Init all function pointers of \a db, init the info text and seed the
- * PRNG.
+ * Init all function pointers of \a s, init the info text and seed the PRNG.
  *
  * \sa struct audio_file_selector, misc_meta_data::selector_info, mysql.c
  */
-int random_selector_init(struct audio_file_selector *db)
+int random_selector_init(struct audio_file_selector *s)
 {
        struct timeval now;
+       unsigned int seed;
 
        PARA_INFO_LOG("%s", "registering random handlers ;)\n");
-       sprintf(mmd->selector_info, "dbinfo1:database info? You're kidding. "
-               "I'm still dopey!\ndbinfo2:\ndbinfo3:\n");
        gettimeofday(&now, NULL);
-       srand(now.tv_usec);
-       db->cmd_list = cmds;
-       db->get_audio_file_list = random_get_audio_file_list;
-       db->shutdown = random_shutdown;
+       seed = now.tv_usec;
+       srand(seed);
+       s->cmd_list = random_selector_cmds;
+       s->get_audio_file_list = random_get_audio_file_list;
+       s->shutdown = random_shutdown;
+       s->update_audio_file = random_update_audio_file;
+       snprintf(mmd->selector_info, MMD_INFO_SIZE - 1,
+               "dbinfo1: Welcome to the random selector\n"
+               "dbinfo2: random_dir: %s\n", conf.random_dir_arg);
+       mmd->selector_info[MMD_INFO_SIZE - 1] = '\0';
        return 1;
 }