server/socket/item.C

/*
 * CrossFire, A Multiplayer game for X-windows
 *
 * Copyright (C) 2005, 2006, 2007 Marc Lehmann & Crossfire+ Development Team
 * Copyright (C) 2002 Mark Wedel & Crossfire Development Team
 * Copyright (C) 1992 Frank Tore Johansen
 *
 * 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., 675 Mass Ave, Cambridge, MA 02139, USA.
 *
 * The author can be reached via e-mail to <crossfire@schmorp.de>
 */

/**
 * \file
 * Client/server logic.
 *
 * \date 2003-12-02
 *
 * This contains item logic for client/server.  It doesn't contain
 * the actual commands that send the data, but does contain
 * the logic for what items should be sent.
 */

#include <global.h>
#include <object.h>
#include <sproto.h>

/** This is the maximum number of bytes we expect any one item to take up */
#define MAXITEMLEN  300

#if 0
tag_t
client_container::tag () const
{
  switch (type)
    {
      case CC_INVENTORY:
        return ns->pl->count;
      case CC_MAPSPACE:
        return 0;
      case CC_CONTAINER:
        return env->count;
    }

  abort ();
}

void
client_container::clear ()
{
  switch (type)
    {
      case CC_INVENTORY:
        abort ();

      case CC_MAPSPACE:
      case CC_CONTAINER:
        ns->send_packet_printf ("delinv %d", tag ());
        break;
    }

  for (iterator i = begin (); i != end (); ++i)
    i->op->seen_by = 0;

  vector< refitem, slice_allocator<refitem> >::clear ();
}

inline iterator
client_container::merge_item (iterator i, object *op)
{
  if (i != end () && i->op == op)
    return ++i;

  if (op->seen_by)
    return; // seen by another entity already

  op->seen_by = this;

  refitem ref;
  ref.op = op;

  return insert (i, ref);
}

void
client_container::update (int offset)
{
  iterator i = begin ();

  switch (type)
    {
      case CC_INVENTORY:
      case CC_CONTAINER:
        {
          object *env = type == CC_INVENTORY
            ? ns->pl->ob
            : this->env;

          // pass 1, erase all objects no longer in container
          for (iterator j = begin (); j != end (); ++j)
            if (j->op->env != env)
              {
                j->op->seen_by = 0;
                erase (j);
              }

          // pass 2 merge items
          for (object *op = env->inv; op; op = op->below)
            {
              if (--offset < 0)
                i = merge_item (i, op);
              else if (offset < -FLOORBOX_PAGESIZE)
                break;
            }
        }
        break;

      case CC_MAPSPACE:
        {
          // pass 1, erase all objects no longer on space
          for (iterator j = begin (); j != end (); ++j)
            if (j->op->x != x || j->op->y != y || j->op->map != map)
              {
                j->op->seen_by = 0;
                erase (j);
              }

          // pass 2 merge items
          for (object *op = GET_MAP_OB (map, x, y); op; op = op->above)
            {
              if (--offset < 0)
                i = merge_item (i, op);
              else if (offset < -FLOORBOX_PAGESIZE)
                break;
            }
        }
        break;
    }

  // pass 3, erase all extra items
  for (iterator j = i; j != end (); ++j)
    j->op->seen_by = 0;

  if (i != end ())
    erase (i, end ());
}

void
client_container::set_mapspace (maptile *map, int x, int y)
{
  if (type == CC_MAPSPACE
      && this->map == map
      && this->x   == x
      && this->y   == y)
    return;

  clear ();

  type      = CC_MAPSPACE;
  this->map = map;
  this->x   = x;
  this->y   = y;
}

void
client_container::set_container (object *env)
{
}
#endif

/*******************************************************************************
 *
 * Functions related to sending object data to the client.
 *
 ******************************************************************************/

/**
 *  This is a similar to query_name, but returns flags
 *  to be sent to client. 
 */
unsigned int
query_flags (object *op)
{
  unsigned int flags = 0;

  if (QUERY_FLAG (op, FLAG_APPLIED))
    {
      switch (op->type)
        {
          case BOW:
          case WAND:
          case ROD:
          case HORN:
            flags = a_readied;
            break;
          case WEAPON:
            flags = a_wielded;
            break;
          case SKILL:
          case ARMOUR:
          case HELMET:
          case SHIELD:
          case RING:
          case BOOTS:
          case GLOVES:
          case AMULET:
          case GIRDLE:
          case BRACERS:
          case CLOAK:
            flags = a_worn;
            break;
          case CONTAINER:
            flags = a_active;
            break;
          default:
            flags = a_applied;
            break;
        }
    }

  if (op->type == CONTAINER && ((op->env && op->env->container == op) || (!op->env && QUERY_FLAG (op, FLAG_APPLIED))))
    flags |= F_OPEN;

  if (QUERY_FLAG (op, FLAG_KNOWN_CURSED))
    {
      if (QUERY_FLAG (op, FLAG_DAMNED))
        flags |= F_DAMNED;
      else if (QUERY_FLAG (op, FLAG_CURSED))
        flags |= F_CURSED;
    }

  if (QUERY_FLAG (op, FLAG_KNOWN_MAGICAL) && !QUERY_FLAG (op, FLAG_IDENTIFIED))
    flags |= F_MAGIC;
  if (QUERY_FLAG (op, FLAG_UNPAID))
    flags |= F_UNPAID;
  if (QUERY_FLAG (op, FLAG_INV_LOCKED))
    flags |= F_LOCKED;

  return flags;
}

/* Used in the send_look to put object head into packet
 * sl for socket ns.  Need socket to know if we need to send
 * animation of face to the client.
 */
static void
add_object_to_socklist (client &ns, packet &sl, object *head)
{
  int flags, len, anim_speed;
  char item_n[MAX_BUF];
  const char *item_p;

  flags = query_flags (head);
  if (QUERY_FLAG (head, FLAG_NO_PICK))
    flags |= F_NOPICK;

  ns.send_face (head->face);
  ns.flush_fx ();

  if (QUERY_FLAG (head, FLAG_ANIMATE) && !ns.anims_sent[head->animation_id])
    ns.send_animation (head->animation_id);

  sl << uint32 (head->count)
     << uint32 (flags)
     << uint32 (QUERY_FLAG (head, FLAG_NO_PICK) ? -1 : WEIGHT (head))
     << uint32 (head->face);

  if (!head->custom_name)
    {
      strncpy (item_n, query_base_name (head, 0), 127);
      item_n[127] = 0;
      len = strlen (item_n);
      item_p = query_base_name (head, 1);
    }
  else
    {
      strncpy (item_n, head->custom_name, 127);
      item_n[127] = 0;
      len = strlen (item_n);
      item_p = head->custom_name;
    }

  strncpy (item_n + len + 1, item_p, 127);
  item_n[254] = 0;
  len += strlen (item_n + 1 + len) + 1;

  sl << data8 (item_n, len)
     << uint16 (head->animation_id);

  anim_speed = 0;
  if (QUERY_FLAG (head, FLAG_ANIMATE))
    {
      if (head->anim_speed)
        anim_speed = head->anim_speed;
      else
        {
          if (fabs (head->speed) < 0.001)
            anim_speed = 255;
          else if (fabs (head->speed) >= 1.0)
            anim_speed = 1;
          else
            anim_speed = (int) (1.0 / fabs (head->speed));
        }

      if (anim_speed > 255)
        anim_speed = 255;
    }

  sl << uint8  (anim_speed)
     << uint32 (head->nrof);

  if (ns.itemcmd == 2)
    sl << uint16 (head->client_type);

  SET_FLAG (head, FLAG_CLIENT_SENT);
}

/**
 * Send the look window. Don't need to do animations here 
 * This sends all the faces to the client, not just updates. This is
 * because object ordering would otherwise be inconsistent.
 */
void
esrv_draw_look (object *pl)
{
  int got_one = 0, start_look = 0, end_look = 0;

  if (!pl->contr->ns->update_look)
    {
      LOG (llevDebug, "esrv_draw_look called when update_look was not set (player %s)\n", &pl->name);
      return;
    }
  else
    pl->contr->ns->update_look = 0;

  if (QUERY_FLAG (pl, FLAG_REMOVED)
      || !pl->map
      || pl->map->in_memory != MAP_IN_MEMORY
      || out_of_map (pl->map, pl->x, pl->y))
    return;

  pl->contr->ns->send_packet ("delinv 0");

  packet sl;
  sl.printf ("item%d ", pl->contr->ns->itemcmd);

  sl << uint32 (0);

  pl->contr->ns->send_face (empty_face);
  pl->contr->ns->flush_fx ();

  if (pl->contr->ns->look_position)
    {
      char buf[80];
      snprintf (buf, 80, "Apply this to see %d previous items", FLOORBOX_PAGESIZE);

      sl << uint32 (0x80000000 | (pl->contr->ns->look_position - FLOORBOX_PAGESIZE))
         << uint32 (0)
         << sint32 (-1)
         << uint32 (empty_face)
         << data8 (buf)
         << uint16 (0)
         << uint8  (0)
         << uint32 (0);

      if (pl->contr->ns->itemcmd == 2)
        sl << uint16 (0);
    }

  object *tmp = pl->ms ().top;
  for (object *last = 0; tmp != last; tmp = tmp->below)
    {
      object *head;

      if (QUERY_FLAG (tmp, FLAG_IS_FLOOR) && !last)
        {
          last = tmp->below;    /* assumes double floor mode */
          if (last && QUERY_FLAG (last, FLAG_IS_FLOOR))
            last = last->below;
        }

      if (tmp->client_visible ())
        {
          if (++start_look < pl->contr->ns->look_position)
            continue;

          end_look++;

          if (end_look > FLOORBOX_PAGESIZE)
            {
              /* What we basically do is make a 'fake' object - when the user applies it,
               * we notice the special tag the object has, and act accordingly.
               */
              sl << uint32 (0x80000000 | (pl->contr->ns->look_position + FLOORBOX_PAGESIZE))
                 << uint32 (0)
                 << uint32 ((uint32) - 1)
                 << uint32 (empty_face)
                 << data8  ("Apply this to see next group of items")
                 << uint16 (0)
                 << uint8  (0)
                 << uint32 (0);

              if (pl->contr->ns->itemcmd == 2)
                sl << uint16 (0);

              break;
            }

          if (tmp->head)
            head = tmp->head;
          else
            head = tmp;

          add_object_to_socklist (*pl->contr->ns, sl, head);
          got_one++;

          if (sl.length () >= (MAXSOCKBUF - MAXITEMLEN))
            {
              pl->contr->ns->send_packet (sl);

              sl.reset ();
              sl.printf ("item%d ", pl->contr->ns->itemcmd);
              sl << uint32 (0);
              got_one = 0;
            }
        }
    }
  
  if (got_one)
    pl->contr->ns->send_packet (sl);

}

/**
 * Sends whole inventory.
 */
void
esrv_send_inventory (object *pl, object *op)
{
  if (!pl->contr->ns)//D
    return;

  int got_one = 0;

  pl->contr->ns->send_packet_printf ("delinv %d", op->count);

  packet sl;
  sl.printf ("item%d ", pl->contr->ns->itemcmd);

  sl << uint32 (op->count);

  for (object *tmp = op->inv; tmp; tmp = tmp->below)
    {
      object *head;

      if (tmp->head)
        head = tmp->head;
      else
        head = tmp;

      if (head->client_visible ())
        {
          add_object_to_socklist (*pl->contr->ns, sl, head);

          got_one++;

          /* IT is possible for players to accumulate a huge amount of
           * items (especially with some of the bags out there) to
           * overflow the buffer.  IF so, send multiple item commands.
           */
          if (sl.length () >= (MAXSOCKBUF - MAXITEMLEN))
            {
              pl->contr->ns->send_packet (sl);

              sl.reset ();
              sl.printf ("item%d ", pl->contr->ns->itemcmd);
              sl << uint32 (op->count);
              got_one = 0;
            }
        }
    }

  if (got_one)
    pl->contr->ns->send_packet (sl);
}

/**
 * Updates object *op for player *pl.
 *
 * flags is a list of values to update
 * to the client (as defined in newclient.h - might as well use the
 * same value both places.
 */
void
esrv_update_item (int flags, object *pl, object *op)
{
  /* If we have a request to send the player item, skip a few checks. */
  if (op != pl)
    {
      if (!op->client_visible ())
        return;
      /* we remove the check for op->env, because in theory, the object
       * is hopefully in the same place, so the client should preserve
       * order.
       */
    }

  client *ns = pl->contr->ns;
  if (!ns)
    return;

  if (!QUERY_FLAG (op, FLAG_CLIENT_SENT))
    {
      /* FLAG_CLIENT_SENT is debug only.  We are using it to see where
       * this is happening - we can set a breakpoint here in the debugger
       * and track back the call.
       */
      LOG (llevDebug, "We have not sent item %s (%d)\n", &op->name, op->count);
    }

  packet sl ("upditem");

  sl << uint8 (flags);

  if (op->head)
    op = op->head;

  sl << uint32 (op->count);

  if (flags & UPD_LOCATION)
    sl << uint32 (op->env ? op->env->count : 0);

  if (flags & UPD_FLAGS)
    sl << uint32 (query_flags (op));

  if (flags & UPD_WEIGHT)
    {
      sint32 weight = WEIGHT (op);

      sl << uint32 (QUERY_FLAG (op, FLAG_NO_PICK) ? -1 : weight);

      if (pl == op)
        ns->last_weight = weight;
    }

  if (flags & UPD_FACE)
    {
      ns->send_face (op->face);
      ns->flush_fx ();
      sl << uint32 (op->face);
    }

  if (flags & UPD_NAME)
    {
      int len;
      const char *item_p;
      char item_n[MAX_BUF];

      if (!op->custom_name)
        {
          strncpy (item_n, query_base_name (op, 0), 127);
          item_n[127] = 0;
          len = strlen (item_n);
          item_p = query_base_name (op, 1);
        }
      else
        {
          strncpy (item_n, op->custom_name, 127);
          item_n[127] = 0;
          len = strlen (item_n);
          item_p = op->custom_name;
        }

      strncpy (item_n + len + 1, item_p, 127);
      item_n[254] = 0;
      len += strlen (item_n + 1 + len) + 1;

      sl << data8 (item_n, len);
    }

  if (flags & UPD_ANIM)
    sl << uint16 (op->animation_id);

  if (flags & UPD_ANIMSPEED)
    {
      int anim_speed = 0;

      if (QUERY_FLAG (op, FLAG_ANIMATE))
        {
          if (op->anim_speed)
            anim_speed = op->anim_speed;
          else
            {
              if (fabs (op->speed) < 0.001)
                anim_speed = 255;
              else if (fabs (op->speed) >= 1.0)
                anim_speed = 1;
              else
                anim_speed = (int) (1.0 / fabs (op->speed));
            }

          if (anim_speed > 255)
            anim_speed = 255;
        }

      sl << uint8  (anim_speed);
    }

  if (flags & UPD_NROF)
    sl << uint32 (op->nrof);

  pl->contr->ns->send_packet (sl);
}

/**
 * Sends item's info to player.
 */
void
esrv_send_item (object *pl, object *op)
{
  if (!pl->contr->ns)
    return;

  /* If this is not the player object, do some more checks */
  if (op != pl)
    {
      /* We only send 'visibile' objects to the client */
      if (!op->client_visible ())
        return;

      /* if the item is on the ground, mark that the look needs to
       * be updated.
       */
      if (!op->env)
        {
          pl->contr->ns->floorbox_update ();
          return;
        }
    }

  packet sl;

  sl.printf ("item%d ", pl->contr->ns->itemcmd);

  if (op->head)
    op = op->head;

  sl << uint32 (op->env ? op->env->count : 0);

  add_object_to_socklist (*pl->contr->ns, sl, op);

  pl->contr->ns->send_packet (sl);
  SET_FLAG (op, FLAG_CLIENT_SENT);
}

/**
 * Tells the client to delete an item.  Uses the item
 * command with a -1 location.
 */
void
esrv_del_item (player *pl, int tag)
{
  if (!pl->ns)
    return;

  packet sl ("delitem");

  sl << uint32 (tag);

  pl->ns->send_packet (sl);
}


/*******************************************************************************
 *
 * Client has requested us to do something with an object.
 *
 ******************************************************************************/

/**
 * Takes a player and object count (tag) and returns the actual object
 * pointer, or null if it can't be found.
 */

object *
esrv_get_ob_from_count (object *pl, tag_t count)
{
  object *op, *tmp;

  if (pl->count == count)
    return pl;

  for (op = pl->inv; op; op = op->below)
    if (op->count == count)
      return op;
    else if (op->type == CONTAINER && pl->container == op)
      for (tmp = op->inv; tmp; tmp = tmp->below)
        if (tmp->count == count)
          return tmp;

  for (op = GET_MAP_OB (pl->map, pl->x, pl->y); op; op = op->above)
    if (op->head && op->head->count == count)
      return op;
    else if (op->count == count)
      return op;
    else if (op->type == CONTAINER && pl->container == op)
      for (tmp = op->inv; tmp; tmp = tmp->below)
        if (tmp->count == count)
          return tmp;

  return 0;
}


/** Client wants to examine some object.  So lets do so. */
void
ExamineCmd (char *buf, int len, player *pl)
{
  tag_t tag = atoi (buf);

  /* If the high bit is set, player examined a pseudo object. */
  if (tag & 0x80000000)
    return;

  object *op = esrv_get_ob_from_count (pl->ob, tag);

  if (!op)
    {
      LOG (llevDebug, "Player '%s' tried to examine the unknown object (%ld)\n", &pl->ob->name, tag);
      return;
    }

  examine (pl->ob, op);
}

/** Client wants to apply some object. Lets do so. */
void
ApplyCmd (char *buf, int len, player *pl)
{
  tag_t tag = atoi (buf);

  /* sort of a hack, but if the player saves and the player then manually
   * applies a savebed (or otherwise tries to do stuff), we run into trouble.
   */
  if (QUERY_FLAG (pl->ob, FLAG_REMOVED))
    return;

  /* If the high bit is set, player applied a pseudo object. */
  if (tag & 0x80000000)
    {
      pl->ns->look_position = tag & 0x7fffffff;
      pl->ns->floorbox_update ();
      return;
    }

  object *op = esrv_get_ob_from_count (pl->ob, tag);

  if (!op)
    {
      LOG (llevDebug, "Player '%s' tried to apply the unknown object (%d)\n", &pl->ob->name, tag);
      return;
    }

  player_apply (pl->ob, op, 0, 0);
}

/** Client wants to lock some object. Lets do so. */
void
LockItem (char *data, int len, player *pl)
{
  int flag = data[0];
  tag_t tag = net_uint32 ((uint8 *)data + 1);
  object *op = esrv_get_ob_from_count (pl->ob, tag);

  if (!op)
    {
      new_draw_info (NDI_UNIQUE, 0, pl->ob, "Could not find object to lock/unlock");
      return;
    }

  if (!flag)
    CLEAR_FLAG (op, FLAG_INV_LOCKED);
  else
    SET_FLAG (op, FLAG_INV_LOCKED);

  esrv_update_item (UPD_FLAGS, pl->ob, op);
}

/** Client wants to mark some object.  Lets do so. */
void
MarkItem (char *data, int len, player *pl)
{
  tag_t tag = net_uint32 ((uint8 *)data);
  object *op = esrv_get_ob_from_count (pl->ob, tag);

  if (!op)
    {
      new_draw_info (NDI_UNIQUE, 0, pl->ob, "Could not find object to mark");
      return;
    }

  pl->mark = op;
  new_draw_info_format (NDI_UNIQUE, 0, pl->ob, "Marked item %s", query_name (op));
}

/**
 * look_at prints items on the specified square.
 *
 * [ removed EARTHWALL check and added check for containers inventory.
 *   Tero.Haatanen@lut.fi ]
 */
void
look_at (object *op, int dx, int dy)
{
  object *tmp;
  int flag = 0;
  sint16 x, y;
  maptile *m;

  x = op->x + dx;
  y = op->y + dy;

  if (out_of_map (op->map, x, y))
    return;

  m = get_map_from_coord (op->map, &x, &y);
  if (!m)
    return;

  for (tmp = GET_MAP_OB (m, x, y); tmp != NULL && tmp->above != NULL; tmp = tmp->above);

  for (; tmp != NULL; tmp = tmp->below)
    {
      if (tmp->invisible && !QUERY_FLAG (op, FLAG_WIZ))
        continue;

      if (!flag)
        {
          if (dx || dy)
            new_draw_info (NDI_UNIQUE, 0, op, "There you see:");
          else
            {
              clear_win_info (op);
              new_draw_info (NDI_UNIQUE, 0, op, "You see:");
            }
          flag = 1;
        }

      if (QUERY_FLAG (op, FLAG_WIZ))
        new_draw_info_format (NDI_UNIQUE, 0, op, "- %s (%d).", query_name (tmp), tmp->count);
      else
        new_draw_info_format (NDI_UNIQUE, 0, op, "- %s.", query_name (tmp));

      if (((tmp->inv != NULL || (tmp->head && tmp->head->inv)) &&
           (tmp->type != CONTAINER && tmp->type != FLESH)) || QUERY_FLAG (op, FLAG_WIZ))
        inventory (op, tmp->head == NULL ? tmp : tmp->head);

      if (QUERY_FLAG (tmp, FLAG_IS_FLOOR) && !QUERY_FLAG (op, FLAG_WIZ))        /* don't continue under the floor */
        break;
    }

  if (!flag)
    {
      if (dx || dy)
        new_draw_info (NDI_UNIQUE, 0, op, "You see nothing there.");
      else
        new_draw_info (NDI_UNIQUE, 0, op, "You see nothing.");
    }
}

/** Client wants to look at some object.  Lets do so. */
void
LookAt (char *buf, int len, player *pl)
{
  int dx, dy;
  char *cp;

  dx = atoi (buf);
  if (!(cp = strchr (buf, ' ')))
    {
      return;
    }
  dy = atoi (cp);

  if (fabs (dx) > pl->ns->mapx / 2 || fabs (dy) > pl->ns->mapy / 2)
    return;

  if (pl->blocked_los[dx + pl->ns->mapx / 2][dy + pl->ns->mapy / 2])
    return;

  look_at (pl->ob, dx, dy);
}

/** Move an object to a new location */
void
esrv_move_object (object *pl, tag_t to, tag_t tag, long nrof)
{
  object *op, *env;

  op = esrv_get_ob_from_count (pl, tag);
  if (!op)
    {
      LOG (llevDebug, "Player '%s' tried to move an unknown object (%ld)\n", &pl->name, tag);
      return;
    }

  if (!to)
    {                           /* drop it to the ground */
      if (op->map && !op->env)
        return;

      /* If it is an active container, then we should drop all objects
       * in the container and not the container itself.
       */
      if (op->inv && QUERY_FLAG (op, FLAG_APPLIED))
        {
          object *current, *next;

          for (current = op->inv; current != NULL; current = next)
            {
              next = current->below;
              drop_object (pl, current, 0);
            }

          esrv_update_item (UPD_WEIGHT, pl, op);
        }
      else
        drop_object (pl, op, nrof);

      return;
    }
  else if (to == pl->count)
    {                           /* pick it up to the inventory */
      /* return if player has already picked it up */
      if (op->env == pl)
        return;

      pl->contr->count = nrof;
      pick_up (pl, op);
      return;
    }

  env = esrv_get_ob_from_count (pl, to);
  if (!env)
    {
      LOG (llevDebug, "Player '%s' tried to move object to the unknown location (%d)\n", &pl->name, to);
      return;
    }

  /* put_object_in_sack presumes that necessary sanity checking
   * has already been done (eg, it can be picked up and fits in
   * in a sack, so check for those things.  We should also check
   * an make sure env is in fact a container for that matter.
   */
  if (env->type == CONTAINER && can_pick (pl, op) && sack_can_hold (pl, env, op, nrof))
    put_object_in_sack (pl, env, op, nrof);
}

Revision:	1.43
Committed:	Tue Apr 3 00:21:38 2007 UTC (17 years, 2 months ago) by root
Content type:	text/plain
Branch:	MAIN
Changes since 1.42:	+3 -0 lines
Log Message:	- fix ber encoding - reduce image checksum length to 6 bytes (from 16) - implement fx packet, which reduces face overhead to amortised 10/12 bytes per face instead of 21/32 bytes and allows an unlimited number of faces instead of 2**16.