3 Copyright (C) 2010-2013 celeron55, Perttu Ahola <celeron55@gmail.com>
5 This program is free software; you can redistribute it and/or modify
6 it under the terms of the GNU Lesser General Public License as published by
7 the Free Software Foundation; either version 2.1 of the License, or
8 (at your option) any later version.
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU Lesser General Public License for more details.
15 You should have received a copy of the GNU Lesser General Public License along
16 with this program; if not, write to the Free Software Foundation, Inc.,
17 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
20 #include "inventory.h"
21 #include "serialization.h"
27 #include "util/strfnd.h"
28 #include "content_mapnode.h" // For loading legacy MaterialItems
29 #include "nameidmapping.h" // For loading legacy MaterialItems
30 #include "util/serialize.h"
31 #include "util/string.h"
37 static content_t content_translate_from_19_to_internal(content_t c_from)
39 for (const auto &tt : trans_table_19) {
47 ItemStack::ItemStack(const std::string &name_, u16 count_,
48 u16 wear_, IItemDefManager *itemdef) :
49 name(itemdef->getAlias(name_)),
53 if (name.empty() || count == 0)
55 else if (itemdef->get(name).type == ITEM_TOOL)
59 void ItemStack::serialize(std::ostream &os, bool serialize_meta) const
64 // Check how many parts of the itemstring are needed
66 if (!metadata.empty())
73 os << serializeJsonStringIfNeeded(name);
81 metadata.serialize(os);
83 os << "<metadata size=" << metadata.size() << ">";
87 void ItemStack::deSerialize(std::istream &is, IItemDefManager *itemdef)
92 name = deSerializeJsonStringIfNeeded(is);
96 std::getline(is, tmp, ' ');
98 throw SerializationError("Unexpected text after item name");
100 if(name == "MaterialItem")
102 // Obsoleted on 2011-07-30
108 // Convert old materials
110 material = content_translate_from_19_to_internal(material);
112 throw SerializationError("Too large material number");
113 // Convert old id to name
114 NameIdMapping legacy_nimap;
115 content_mapnode_get_name_id_mapping(&legacy_nimap);
116 legacy_nimap.getName(material, name);
118 name = "unknown_block";
120 name = itemdef->getAlias(name);
121 count = materialcount;
123 else if(name == "MaterialItem2")
125 // Obsoleted on 2011-11-16
132 throw SerializationError("Too large material number");
133 // Convert old id to name
134 NameIdMapping legacy_nimap;
135 content_mapnode_get_name_id_mapping(&legacy_nimap);
136 legacy_nimap.getName(material, name);
138 name = "unknown_block";
140 name = itemdef->getAlias(name);
141 count = materialcount;
143 else if(name == "node" || name == "NodeItem" || name == "MaterialItem3"
144 || name == "craft" || name == "CraftItem")
146 // Obsoleted on 2012-01-07
149 std::getline(is, all, '\n');
150 // First attempt to read inside ""
153 // If didn't skip to end, we have ""s
155 name = fnd.next("\"");
156 } else { // No luck, just read a word then
158 name = fnd.next(" ");
162 name = itemdef->getAlias(name);
163 count = stoi(trim(fnd.next("")));
167 else if(name == "MBOItem")
169 // Obsoleted on 2011-10-14
170 throw SerializationError("MBOItem not supported anymore");
172 else if(name == "tool" || name == "ToolItem")
174 // Obsoleted on 2012-01-07
177 std::getline(is, all, '\n');
178 // First attempt to read inside ""
181 // If didn't skip to end, we have ""s
183 name = fnd.next("\"");
184 } else { // No luck, just read a word then
186 name = fnd.next(" ");
192 name = itemdef->getAlias(name);
193 wear = stoi(trim(fnd.next("")));
197 do // This loop is just to allow "break;"
201 // Apply item aliases
203 name = itemdef->getAlias(name);
206 std::string count_str;
207 std::getline(is, count_str, ' ');
208 if (count_str.empty()) {
213 count = stoi(count_str);
216 std::string wear_str;
217 std::getline(is, wear_str, ' ');
221 wear = stoi(wear_str);
224 metadata.deSerialize(is);
226 // In case fields are added after metadata, skip space here:
227 //std::getline(is, tmp, ' ');
229 // throw SerializationError("Unexpected text after metadata");
234 if (name.empty() || count == 0)
236 else if (itemdef && itemdef->get(name).type == ITEM_TOOL)
240 void ItemStack::deSerialize(const std::string &str, IItemDefManager *itemdef)
242 std::istringstream is(str, std::ios::binary);
243 deSerialize(is, itemdef);
246 std::string ItemStack::getItemString(bool include_meta) const
248 std::ostringstream os(std::ios::binary);
249 serialize(os, include_meta);
253 std::string ItemStack::getDescription(IItemDefManager *itemdef) const
255 std::string desc = metadata.getString("description");
257 desc = getDefinition(itemdef).description;
258 return desc.empty() ? name : desc;
261 std::string ItemStack::getShortDescription(IItemDefManager *itemdef) const
263 std::string desc = metadata.getString("short_description");
265 desc = getDefinition(itemdef).short_description;
268 // no short_description because of old server version or modified builtin
269 // return first line of description
270 std::stringstream sstr(getDescription(itemdef));
271 std::getline(sstr, desc, '\n');
276 ItemStack ItemStack::addItem(ItemStack newitem, IItemDefManager *itemdef)
278 // If the item is empty or the position invalid, bail out
281 // nothing can be added trivially
283 // If this is an empty item, it's an easy job.
289 // If item name or metadata differs, bail out
290 else if (name != newitem.name
291 || metadata != newitem.metadata)
295 // If the item fits fully, add counter and delete it
296 else if(newitem.count <= freeSpace(itemdef))
301 // Else the item does not fit fully. Add all that fits and return
305 u16 freespace = freeSpace(itemdef);
307 newitem.remove(freespace);
313 bool ItemStack::itemFits(ItemStack newitem,
315 IItemDefManager *itemdef) const
318 // If the item is empty or the position invalid, bail out
321 // nothing can be added trivially
323 // If this is an empty item, it's an easy job.
328 // If item name or metadata differs, bail out
329 else if (name != newitem.name
330 || metadata != newitem.metadata)
334 // If the item fits fully, delete it
335 else if(newitem.count <= freeSpace(itemdef))
339 // Else the item does not fit fully. Return the rest.
342 u16 freespace = freeSpace(itemdef);
343 newitem.remove(freespace);
349 return newitem.empty();
352 ItemStack ItemStack::takeItem(u32 takecount)
354 if(takecount == 0 || count == 0)
357 ItemStack result = *this;
358 if(takecount >= count)
367 result.count = takecount;
372 ItemStack ItemStack::peekItem(u32 peekcount) const
374 if(peekcount == 0 || count == 0)
377 ItemStack result = *this;
378 if(peekcount < count)
379 result.count = peekcount;
387 InventoryList::InventoryList(const std::string &name, u32 size, IItemDefManager *itemdef):
395 void InventoryList::clearItems()
399 for (u32 i=0; i < m_size; i++) {
400 m_items.emplace_back();
406 void InventoryList::setSize(u32 newsize)
408 if (newsize == m_items.size())
411 m_items.resize(newsize);
416 void InventoryList::setWidth(u32 newwidth)
422 void InventoryList::setName(const std::string &name)
428 void InventoryList::serialize(std::ostream &os, bool incremental) const
430 //os.imbue(std::locale("C"));
432 os<<"Width "<<m_width<<"\n";
434 for (const auto &item : m_items) {
441 // TODO: Implement this:
442 // if (!incremental || item.checkModified())
447 os<<"EndInventoryList\n";
450 void InventoryList::deSerialize(std::istream &is)
452 //is.imbue(std::locale("C"));
460 std::getline(is, line, '\n');
462 std::istringstream iss(line);
465 std::getline(iss, name, ' ');
467 if (name == "EndInventoryList" || name == "end") {
468 // If partial incremental: Clear leftover items (should not happen!)
469 for (size_t i = item_i; i < m_items.size(); ++i)
474 if (name == "Width") {
477 throw SerializationError("incorrect width property");
479 else if(name == "Item")
481 if(item_i > getSize() - 1)
482 throw SerializationError("too many items");
484 item.deSerialize(iss, m_itemdef);
485 m_items[item_i++] = item;
487 else if(name == "Empty")
489 if(item_i > getSize() - 1)
490 throw SerializationError("too many items");
491 m_items[item_i++].clear();
492 } else if (name == "Keep") {
493 ++item_i; // Unmodified item
497 // Contents given to deSerialize() were not terminated properly: throw error.
499 std::ostringstream ss;
500 ss << "Malformatted inventory list. list="
501 << m_name << ", read " << item_i << " of " << getSize()
502 << " ItemStacks." << std::endl;
503 throw SerializationError(ss.str());
506 InventoryList::InventoryList(const InventoryList &other)
511 InventoryList & InventoryList::operator = (const InventoryList &other)
513 m_items = other.m_items;
514 m_size = other.m_size;
515 m_width = other.m_width;
516 m_name = other.m_name;
517 m_itemdef = other.m_itemdef;
523 bool InventoryList::operator == (const InventoryList &other) const
525 if(m_size != other.m_size)
527 if(m_width != other.m_width)
529 if(m_name != other.m_name)
531 for (u32 i = 0; i < m_items.size(); i++)
532 if (m_items[i] != other.m_items[i])
538 const std::string &InventoryList::getName() const
543 u32 InventoryList::getSize() const
545 return m_items.size();
548 u32 InventoryList::getWidth() const
553 u32 InventoryList::getUsedSlots() const
556 for (const auto &m_item : m_items) {
563 const ItemStack& InventoryList::getItem(u32 i) const
565 assert(i < m_size); // Pre-condition
569 ItemStack& InventoryList::getItem(u32 i)
571 assert(i < m_size); // Pre-condition
575 ItemStack InventoryList::changeItem(u32 i, const ItemStack &newitem)
577 if(i >= m_items.size())
580 ItemStack olditem = m_items[i];
581 m_items[i] = newitem;
586 void InventoryList::deleteItem(u32 i)
588 assert(i < m_items.size()); // Pre-condition
593 ItemStack InventoryList::addItem(const ItemStack &newitem_)
595 ItemStack newitem = newitem_;
601 First try to find if it could be added to some existing items
603 for(u32 i=0; i<m_items.size(); i++)
605 // Ignore empty slots
606 if(m_items[i].empty())
609 newitem = addItem(i, newitem);
611 return newitem; // All was eaten
615 Then try to add it to empty slots
617 for(u32 i=0; i<m_items.size(); i++)
619 // Ignore unempty slots
620 if(!m_items[i].empty())
623 newitem = addItem(i, newitem);
625 return newitem; // All was eaten
632 ItemStack InventoryList::addItem(u32 i, const ItemStack &newitem)
634 if(i >= m_items.size())
637 ItemStack leftover = m_items[i].addItem(newitem, m_itemdef);
638 if (leftover != newitem)
643 bool InventoryList::itemFits(const u32 i, const ItemStack &newitem,
644 ItemStack *restitem) const
646 if(i >= m_items.size())
653 return m_items[i].itemFits(newitem, restitem, m_itemdef);
656 bool InventoryList::roomForItem(const ItemStack &item_) const
658 ItemStack item = item_;
660 for(u32 i=0; i<m_items.size(); i++)
662 if(itemFits(i, item, &leftover))
669 bool InventoryList::containsItem(const ItemStack &item, bool match_meta) const
671 u32 count = item.count;
675 for (auto i = m_items.rbegin(); i != m_items.rend(); ++i) {
678 if (i->name == item.name && (!match_meta || (i->metadata == item.metadata))) {
679 if (i->count >= count)
688 ItemStack InventoryList::removeItem(const ItemStack &item)
691 for (auto i = m_items.rbegin(); i != m_items.rend(); ++i) {
692 if (i->name == item.name) {
693 u32 still_to_remove = item.count - removed.count;
694 ItemStack leftover = removed.addItem(i->takeItem(still_to_remove),
696 // Allow oversized stacks
697 removed.count += leftover.count;
699 if (removed.count == item.count)
703 if (!removed.empty())
708 ItemStack InventoryList::takeItem(u32 i, u32 takecount)
710 if(i >= m_items.size())
713 ItemStack taken = m_items[i].takeItem(takecount);
719 void InventoryList::moveItemSomewhere(u32 i, InventoryList *dest, u32 count)
721 // Take item from source list
724 item1 = changeItem(i, ItemStack());
726 item1 = takeItem(i, count);
732 leftover = dest->addItem(item1);
734 if (!leftover.empty()) {
735 // Add the remaining part back to the source item
736 addItem(i, leftover);
740 u32 InventoryList::moveItem(u32 i, InventoryList *dest, u32 dest_i,
741 u32 count, bool swap_if_needed, bool *did_swap)
743 if (this == dest && i == dest_i)
746 // Take item from source list
749 item1 = changeItem(i, ItemStack());
751 item1 = takeItem(i, count);
756 // Try to add the item to destination list
757 u32 oldcount = item1.count;
758 item1 = dest->addItem(dest_i, item1);
760 // If something is returned, the item was not fully added
761 if (!item1.empty()) {
762 // If olditem is returned, nothing was added.
763 bool nothing_added = (item1.count == oldcount);
765 // If something else is returned, part of the item was left unadded.
766 // Add the other part back to the source item
769 // If olditem is returned, nothing was added.
771 if (nothing_added && swap_if_needed) {
772 // Tell that we swapped
773 if (did_swap != NULL) {
776 // Take item from source list
777 item1 = changeItem(i, ItemStack());
778 // Adding was not possible, swap the items.
779 ItemStack item2 = dest->changeItem(dest_i, item1);
780 // Put item from destination list to the source list
781 changeItem(i, item2);
784 return (oldcount - item1.count);
791 Inventory::~Inventory()
796 void Inventory::clear()
798 for (auto &m_list : m_lists) {
805 Inventory::Inventory(IItemDefManager *itemdef)
811 Inventory::Inventory(const Inventory &other)
816 Inventory & Inventory::operator = (const Inventory &other)
818 // Gracefully handle self assignment
822 m_itemdef = other.m_itemdef;
823 for (InventoryList *list : other.m_lists) {
824 m_lists.push_back(new InventoryList(*list));
831 bool Inventory::operator == (const Inventory &other) const
833 if(m_lists.size() != other.m_lists.size())
836 for(u32 i=0; i<m_lists.size(); i++)
838 if(*m_lists[i] != *other.m_lists[i])
844 void Inventory::serialize(std::ostream &os, bool incremental) const
846 //std::cout << "Serialize " << (int)incremental << ", n=" << m_lists.size() << std::endl;
847 for (const InventoryList *list : m_lists) {
848 if (!incremental || list->checkModified()) {
849 os << "List " << list->getName() << " " << list->getSize() << "\n";
850 list->serialize(os, incremental);
852 os << "KeepList " << list->getName() << "\n";
856 os<<"EndInventory\n";
859 void Inventory::deSerialize(std::istream &is)
861 std::vector<InventoryList *> new_lists;
862 new_lists.reserve(m_lists.size());
866 std::getline(is, line, '\n');
868 std::istringstream iss(line);
871 std::getline(iss, name, ' ');
873 if (name == "EndInventory" || name == "end") {
874 // Remove all lists that were not sent
875 for (auto &list : m_lists) {
876 if (std::find(new_lists.begin(), new_lists.end(), list) != new_lists.end())
883 m_lists.erase(std::remove(m_lists.begin(), m_lists.end(),
884 nullptr), m_lists.end());
888 if (name == "List") {
889 std::string listname;
892 std::getline(iss, listname, ' ');
895 InventoryList *list = getList(listname);
896 bool create_new = !list;
898 list = new InventoryList(listname, listsize, m_itemdef);
900 list->setSize(listsize);
901 list->deSerialize(is);
903 new_lists.push_back(list);
905 m_lists.push_back(list);
907 } else if (name == "KeepList") {
908 // Incrementally sent list
909 std::string listname;
910 std::getline(iss, listname, ' ');
912 InventoryList *list = getList(listname);
914 new_lists.push_back(list);
916 errorstream << "Inventory::deSerialize(): Tried to keep list '" <<
917 listname << "' which is non-existent." << std::endl;
920 // Any additional fields will throw errors when received by a client
921 // older than PROTOCOL_VERSION 38
924 // Contents given to deSerialize() were not terminated properly: throw error.
926 std::ostringstream ss;
927 ss << "Malformatted inventory (damaged?). "
928 << m_lists.size() << " lists read." << std::endl;
929 throw SerializationError(ss.str());
932 InventoryList * Inventory::addList(const std::string &name, u32 size)
936 // Remove existing lists
937 s32 i = getListIndex(name);
940 m_lists[i] = new InventoryList(name, size, m_itemdef);
941 m_lists[i]->setModified();
945 //don't create list with invalid name
946 if (name.find(' ') != std::string::npos)
949 InventoryList *list = new InventoryList(name, size, m_itemdef);
951 m_lists.push_back(list);
955 InventoryList * Inventory::getList(const std::string &name)
957 s32 i = getListIndex(name);
963 std::vector<const InventoryList*> Inventory::getLists()
965 std::vector<const InventoryList*> lists;
966 lists.reserve(m_lists.size());
967 for (auto list : m_lists) {
968 lists.push_back(list);
973 bool Inventory::deleteList(const std::string &name)
975 s32 i = getListIndex(name);
981 m_lists.erase(m_lists.begin() + i);
985 const InventoryList *Inventory::getList(const std::string &name) const
987 s32 i = getListIndex(name);
993 s32 Inventory::getListIndex(const std::string &name) const
995 for(u32 i=0; i<m_lists.size(); i++)
997 if(m_lists[i]->getName() == name)