Changeset 1420

Timestamp:

06/01/09 11:06:50 (15 months ago)

Author:

ajps

Message:

Add some safety checking of input to the study commands - we can't assume that all game commands can be 'trusted'.

Location:

trunk/src

Files:

• cmd-obj.c (modified) (4 diffs)
• cmd5.c (modified) (3 diffs)
• object/obj-ui.c (modified) (1 diff)
• object/obj-util.c (modified) (1 diff)
• object/object.h (modified) (1 diff)
• player/player.h (modified) (1 diff)
• player/util.c (modified) (2 diffs)

trunk/src/cmd-obj.c

@@ -340 +340 @@
 /*** Casting and browsing ***/
 
-static bool obj_cast_pre(void)
-{
-        if (!cp_ptr->spell_book)
-        {
-                msg_print("You cannot pray or produce magics.");
-                return FALSE;
-        }
-
-        if (p_ptr->timed[TMD_BLIND] || no_lite())
-        {
-                msg_print("You cannot see!");
-                return FALSE;
-        }
-
-        if (p_ptr->timed[TMD_CONFUSED])
-        {
-                msg_print("You are too confused!");
-                return FALSE;
-        }
-
-        return TRUE;
-}
-
-/* A prerequisite to studying */
-static bool obj_study_pre(void)
-{
-        if (!obj_cast_pre())
-                return FALSE;
-
-        if (!p_ptr->new_spells)
-        {
-                cptr p = ((cp_ptr->spell_book == TV_MAGIC_BOOK) ? "spell" : "prayer");
-                msg_format("You cannot learn any new %ss!", p);
-                return FALSE;
-        }
-
-        return TRUE;
-}
-
-
 /* Peruse spells in a book */
 static void obj_browse(object_type *o_ptr, int item)
@@ -441 +401 @@
 
 /*** Using items the traditional way ***/
-
-/* Determine if the player can read scrolls. */
-static bool obj_read_pre(void)
-{
-        if (p_ptr->timed[TMD_BLIND])
-        {
-                msg_print("You can't see anything.");
-                return FALSE;
-        }
-
-        if (no_lite())
-        {
-                msg_print("You have no light to read by.");
-                return FALSE;
-        }
-
-        if (p_ptr->timed[TMD_CONFUSED])
-        {
-                msg_print("You are too confused to read!");
-                return FALSE;
-        }
-
-        if (p_ptr->timed[TMD_AMNESIA])
-        {
-                msg_print("You can't remember how to read!");
-                return FALSE;
-        }
-
-        return TRUE;
-}
-
 
 /*
@@ -772 +701 @@
         { obj_study, CMD_NULL, "study",
           "Study which book? ", "You have no books that you can read.",
-          obj_can_browse, (USE_INVEN | USE_FLOOR), obj_study_pre },
+          obj_can_browse, (USE_INVEN | USE_FLOOR), player_can_study },
 
         { obj_cast, CMD_NULL, "cast",
           "Use which book? ", "You have no books that you can read.",
-          obj_can_browse, (USE_INVEN | USE_FLOOR), obj_cast_pre },
+          obj_can_browse, (USE_INVEN | USE_FLOOR), player_can_cast },
 
         /*** Item usage ***/
@@ -805 +734 @@
         { NULL, CMD_READ_SCROLL, "read",
       "Read which scroll? ", "You have no scrolls to read.",
-          obj_is_scroll, (USE_INVEN | USE_FLOOR), obj_read_pre },
+          obj_is_scroll, (USE_INVEN | USE_FLOOR), player_can_read },
 
         { NULL, CMD_REFILL, "refill",

trunk/src/cmd5.c

@@ -525 +525 @@
 }
 
+/* Check if the given spell is in the given book. */
+static bool spell_in_book(int spell, int book)
+{
+        int i;
+        object_type *o_ptr = object_from_item_idx(book);
+
+        for (i = 0; i < SPELLS_PER_BOOK; i++)
+        {
+                if (spell == get_spell_index(o_ptr, i))
+                        return TRUE;
+        }
+
+        return FALSE;
+}
 
 /* Gain a specific spell, specified by spell number (for mages). */
@@ -531 +545 @@
         int spell = args[0].choice;
 
-        spell_learn(spell);
-        p_ptr->energy_use = 100;
+        int item_list[INVEN_TOTAL + MAX_FLOOR_STACK];
+        int item_num;
+        int i;
+
+        /* Check the player can study at all atm */
+        if (!player_can_study())
+                return;
+
+        /* Check that the player can actually learn the nominated spell. */
+        item_tester_hook = obj_can_browse;
+        item_num = scan_items(item_list, N_ELEMENTS(item_list), (USE_INVEN | USE_FLOOR));
+
+        /* Check through all available books */
+        for (i = 0; i < item_num; i++)
+        {
+                if (spell_in_book(spell, item_list[i]))
+                {
+                        if (spell_okay(spell, FALSE, FALSE))
+                        {
+                                /* Spell is in an available book, and player is capable. */
+                                spell_learn(spell);
+                                p_ptr->energy_use = 100;
+                        }
+                        else
+                        {
+                                /* Spell is present, but player incapable. */
+                                msg_format("You cannot learn that spell.");
+                        }
+
+                        return;
+                }
+        }
+}
+
+/* Check if the given item is available for the player to use. */
+static bool item_is_available(int item, int mode)
+{
+        int item_list[INVEN_TOTAL + MAX_FLOOR_STACK];
+        int item_num;
+        int i;
+
+        item_num = scan_items(item_list, N_ELEMENTS(item_list), mode);
+
+        for (i = 0; i < item_num; i++)
+        {
+                if (item_list[i] == item)
+                        return TRUE;
+        }
+
+        return FALSE;
 }
 
@@ -545 +607 @@
 
         cptr p = ((cp_ptr->spell_book == TV_MAGIC_BOOK) ? "spell" : "prayer");
+
+        /* Check the player can study at all atm */
+        if (!player_can_study())
+                return;
+
+        /* Check that the player has access to the nominated spell book. */
+        item_tester_hook = obj_can_browse;
+        if (!item_is_available(book, (USE_INVEN | USE_FLOOR)))
+        {
+                msg_format("That item is not within your reach.");
+                return;
+        }
 
         /* Extract spells */

trunk/src/object/obj-ui.c

@@ -598 +598 @@
         /* Allow it */
         return (TRUE);
-}
-
-
-/*
- * Verify the "okayness" of a given item.
- *
- * The item can be negative to mean "item on floor".
- */
-static bool get_item_okay(int item)
-{
-        object_type *o_ptr;
-
-        /* Inventory */
-        if (item >= 0)
-        {
-                o_ptr = &inventory[item];
-        }
-
-        /* Floor */
-        else
-        {
-                o_ptr = &o_list[0 - item];
-        }
-
-        /* Verify the item */
-        return (item_tester_okay(o_ptr));
 }
 

trunk/src/object/obj-util.c

@@ -3650 +3650 @@
 }
 
+
+/*
+ * Verify the "okayness" of a given item.
+ *
+ * The item can be negative to mean "item on floor".
+ */
+bool get_item_okay(int item)
+{
+        /* Verify the item */
+        return (item_tester_okay(object_from_item_idx(item)));
+}
+
+
+/*
+ * Get a list of "valid" item indexes.
+ *
+ * Fills item_list[] with items that are "okay" as defined by the
+ * current item_tester_hook, etc.  mode determines what combination of
+ * inventory, equipment and player's floor location should be used
+ * when drawing up the list.
+ *
+ * Returns the number of items placed into the list.
+ *
+ * Maximum space that can be used is [INVEN_TOTAL + MAX_FLOOR_STACK],
+ * though practically speaking much smaller numbers are likely.
+ */
+int scan_items(int *item_list, size_t item_list_max, int mode)
+{
+        bool use_inven = ((mode & USE_INVEN) ? TRUE : FALSE);
+        bool use_equip = ((mode & USE_EQUIP) ? TRUE : FALSE);
+        bool use_floor = ((mode & USE_FLOOR) ? TRUE : FALSE);
+
+        int floor_list[MAX_FLOOR_STACK];
+        int floor_num;
+
+        int i;
+        int item_list_num = 0;
+
+        if (use_inven)
+        {
+                for (i = 0; i < INVEN_PACK && item_list_num < item_list_max; i++)
+                {
+                        if (get_item_okay(i))
+                                item_list[item_list_num++] = i;
+                }
+        }
+
+        if (use_equip)
+        {
+                for (i = INVEN_WIELD; i < INVEN_TOTAL && item_list_num < item_list_max; i++)
+                {
+                        if (get_item_okay(i))
+                                item_list[item_list_num++] = i;
+                }
+        }
+
+        /* Scan all non-gold objects in the grid */
+        if (use_floor)
+        {
+                floor_num = scan_floor(floor_list, N_ELEMENTS(floor_list), p_ptr->py, p_ptr->px, 0x03);
+
+                for (i = 0; i < floor_num && item_list_num < item_list_max; i++)
+                {
+                        if (get_item_okay(i))
+                                item_list[item_list_num++] = i;
+                }
+        }
+
+        return item_list_num;
+}
+
+
+

trunk/src/object/object.h

@@ -169 +169 @@
 object_type *object_from_item_idx(int item);
 bool obj_needs_aim(object_type *o_ptr);
+bool get_item_okay(int item);
+int scan_items(int *item_list, size_t item_list_max, int mode);
 
 /* obj-power.c and randart.c */

trunk/src/player/player.h

@@ -15 +15 @@
 /* util.c */
 s16b modify_stat_value(int value, int amount);
+bool player_can_cast(void);
+bool player_can_study(void);
+bool player_can_read(void);

trunk/src/player/util.c

@@ -1 +1 @@
 #include "angband.h"
+#include "object/tvalsval.h"
 
 /*
@@ -49 +50 @@
 }
 
+/* Is the player capable of casting a spell? */
+bool player_can_cast(void)
+{
+        if (!cp_ptr->spell_book)
+        {
+                msg_print("You cannot pray or produce magics.");
+                return FALSE;
+        }
+
+        if (p_ptr->timed[TMD_BLIND] || no_lite())
+        {
+                msg_print("You cannot see!");
+                return FALSE;
+        }
+
+        if (p_ptr->timed[TMD_CONFUSED])
+        {
+                msg_print("You are too confused!");
+                return FALSE;
+        }
+
+        return TRUE;
+}
+
+/* Is the player capable of studying? */
+bool player_can_study(void)
+{
+        if (!player_can_cast())
+                return FALSE;
+
+        if (!p_ptr->new_spells)
+        {
+                cptr p = ((cp_ptr->spell_book == TV_MAGIC_BOOK) ? "spell" : "prayer");
+                msg_format("You cannot learn any new %ss!", p);
+                return FALSE;
+        }
+
+        return TRUE;
+}
+
+/* Determine if the player can read scrolls. */
+bool player_can_read(void)
+{
+        if (p_ptr->timed[TMD_BLIND])
+        {
+                msg_print("You can't see anything.");
+                return FALSE;
+        }
+
+        if (no_lite())
+        {
+                msg_print("You have no light to read by.");
+                return FALSE;
+        }
+
+        if (p_ptr->timed[TMD_CONFUSED])
+        {
+                msg_print("You are too confused to read!");
+                return FALSE;
+        }
+
+        if (p_ptr->timed[TMD_AMNESIA])
+        {
+                msg_print("You can't remember how to read!");
+                return FALSE;
+        }
+
+        return TRUE;
+}