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);
463 //iss.imbue(std::locale("C"));
466 std::getline(iss, name, ' ');
468 if (name == "EndInventoryList" || name == "end") {
469 // If partial incremental: Clear leftover items (should not happen!)
470 for (size_t i = item_i; i < m_items.size(); ++i)
475 if (name == "Width") {
478 throw SerializationError("incorrect width property");
480 else if(name == "Item")
482 if(item_i > getSize() - 1)
483 throw SerializationError("too many items");
485 item.deSerialize(iss, m_itemdef);
486 m_items[item_i++] = item;
488 else if(name == "Empty")
490 if(item_i > getSize() - 1)
491 throw SerializationError("too many items");
492 m_items[item_i++].clear();
493 } else if (name == "Keep") {
494 ++item_i; // Unmodified item
498 // Contents given to deSerialize() were not terminated properly: throw error.
500 std::ostringstream ss;
501 ss << "Malformatted inventory list. list="
502 << m_name << ", read " << item_i << " of " << getSize()
503 << " ItemStacks." << std::endl;
504 throw SerializationError(ss.str());
507 InventoryList::InventoryList(const InventoryList &other)
512 InventoryList & InventoryList::operator = (const InventoryList &other)
514 m_items = other.m_items;
515 m_size = other.m_size;
516 m_width = other.m_width;
517 m_name = other.m_name;
518 m_itemdef = other.m_itemdef;
524 bool InventoryList::operator == (const InventoryList &other) const
526 if(m_size != other.m_size)
528 if(m_width != other.m_width)
530 if(m_name != other.m_name)
532 for (u32 i = 0; i < m_items.size(); i++)
533 if (m_items[i] != other.m_items[i])
539 const std::string &InventoryList::getName() const
544 u32 InventoryList::getSize() const
546 return m_items.size();
549 u32 InventoryList::getWidth() const
554 u32 InventoryList::getUsedSlots() const
557 for (const auto &m_item : m_items) {
564 u32 InventoryList::getFreeSlots() const
566 return getSize() - getUsedSlots();
569 const ItemStack& InventoryList::getItem(u32 i) const
571 assert(i < m_size); // Pre-condition
575 ItemStack& InventoryList::getItem(u32 i)
577 assert(i < m_size); // Pre-condition
581 ItemStack InventoryList::changeItem(u32 i, const ItemStack &newitem)
583 if(i >= m_items.size())
586 ItemStack olditem = m_items[i];
587 m_items[i] = newitem;
592 void InventoryList::deleteItem(u32 i)
594 assert(i < m_items.size()); // Pre-condition
599 ItemStack InventoryList::addItem(const ItemStack &newitem_)
601 ItemStack newitem = newitem_;
607 First try to find if it could be added to some existing items
609 for(u32 i=0; i<m_items.size(); i++)
611 // Ignore empty slots
612 if(m_items[i].empty())
615 newitem = addItem(i, newitem);
617 return newitem; // All was eaten
621 Then try to add it to empty slots
623 for(u32 i=0; i<m_items.size(); i++)
625 // Ignore unempty slots
626 if(!m_items[i].empty())
629 newitem = addItem(i, newitem);
631 return newitem; // All was eaten
638 ItemStack InventoryList::addItem(u32 i, const ItemStack &newitem)
640 if(i >= m_items.size())
643 ItemStack leftover = m_items[i].addItem(newitem, m_itemdef);
644 if (leftover != newitem)
649 bool InventoryList::itemFits(const u32 i, const ItemStack &newitem,
650 ItemStack *restitem) const
652 if(i >= m_items.size())
659 return m_items[i].itemFits(newitem, restitem, m_itemdef);
662 bool InventoryList::roomForItem(const ItemStack &item_) const
664 ItemStack item = item_;
666 for(u32 i=0; i<m_items.size(); i++)
668 if(itemFits(i, item, &leftover))
675 bool InventoryList::containsItem(const ItemStack &item, bool match_meta) const
677 u32 count = item.count;
681 for (auto i = m_items.rbegin(); i != m_items.rend(); ++i) {
684 if (i->name == item.name && (!match_meta || (i->metadata == item.metadata))) {
685 if (i->count >= count)
694 ItemStack InventoryList::removeItem(const ItemStack &item)
697 for (auto i = m_items.rbegin(); i != m_items.rend(); ++i) {
698 if (i->name == item.name) {
699 u32 still_to_remove = item.count - removed.count;
700 ItemStack leftover = removed.addItem(i->takeItem(still_to_remove),
702 // Allow oversized stacks
703 removed.count += leftover.count;
705 if (removed.count == item.count)
709 if (!removed.empty())
714 ItemStack InventoryList::takeItem(u32 i, u32 takecount)
716 if(i >= m_items.size())
719 ItemStack taken = m_items[i].takeItem(takecount);
725 void InventoryList::moveItemSomewhere(u32 i, InventoryList *dest, u32 count)
727 // Take item from source list
730 item1 = changeItem(i, ItemStack());
732 item1 = takeItem(i, count);
738 leftover = dest->addItem(item1);
740 if (!leftover.empty()) {
741 // Add the remaining part back to the source item
742 addItem(i, leftover);
746 u32 InventoryList::moveItem(u32 i, InventoryList *dest, u32 dest_i,
747 u32 count, bool swap_if_needed, bool *did_swap)
749 if (this == dest && i == dest_i)
752 // Take item from source list
755 item1 = changeItem(i, ItemStack());
757 item1 = takeItem(i, count);
762 // Try to add the item to destination list
763 u32 oldcount = item1.count;
764 item1 = dest->addItem(dest_i, item1);
766 // If something is returned, the item was not fully added
767 if (!item1.empty()) {
768 // If olditem is returned, nothing was added.
769 bool nothing_added = (item1.count == oldcount);
771 // If something else is returned, part of the item was left unadded.
772 // Add the other part back to the source item
775 // If olditem is returned, nothing was added.
777 if (nothing_added && swap_if_needed) {
778 // Tell that we swapped
779 if (did_swap != NULL) {
782 // Take item from source list
783 item1 = changeItem(i, ItemStack());
784 // Adding was not possible, swap the items.
785 ItemStack item2 = dest->changeItem(dest_i, item1);
786 // Put item from destination list to the source list
787 changeItem(i, item2);
790 return (oldcount - item1.count);
797 Inventory::~Inventory()
802 void Inventory::clear()
804 for (auto &m_list : m_lists) {
811 Inventory::Inventory(IItemDefManager *itemdef)
817 Inventory::Inventory(const Inventory &other)
822 Inventory & Inventory::operator = (const Inventory &other)
824 // Gracefully handle self assignment
828 m_itemdef = other.m_itemdef;
829 for (InventoryList *list : other.m_lists) {
830 m_lists.push_back(new InventoryList(*list));
837 bool Inventory::operator == (const Inventory &other) const
839 if(m_lists.size() != other.m_lists.size())
842 for(u32 i=0; i<m_lists.size(); i++)
844 if(*m_lists[i] != *other.m_lists[i])
850 void Inventory::serialize(std::ostream &os, bool incremental) const
852 //std::cout << "Serialize " << (int)incremental << ", n=" << m_lists.size() << std::endl;
853 for (const InventoryList *list : m_lists) {
854 if (!incremental || list->checkModified()) {
855 os << "List " << list->getName() << " " << list->getSize() << "\n";
856 list->serialize(os, incremental);
858 os << "KeepList " << list->getName() << "\n";
862 os<<"EndInventory\n";
865 void Inventory::deSerialize(std::istream &is)
867 std::vector<InventoryList *> new_lists;
868 new_lists.reserve(m_lists.size());
872 std::getline(is, line, '\n');
874 std::istringstream iss(line);
877 std::getline(iss, name, ' ');
879 if (name == "EndInventory" || name == "end") {
880 // Remove all lists that were not sent
881 for (auto &list : m_lists) {
882 if (std::find(new_lists.begin(), new_lists.end(), list) != new_lists.end())
889 m_lists.erase(std::remove(m_lists.begin(), m_lists.end(),
890 nullptr), m_lists.end());
894 if (name == "List") {
895 std::string listname;
898 std::getline(iss, listname, ' ');
901 InventoryList *list = getList(listname);
902 bool create_new = !list;
904 list = new InventoryList(listname, listsize, m_itemdef);
906 list->setSize(listsize);
907 list->deSerialize(is);
909 new_lists.push_back(list);
911 m_lists.push_back(list);
913 } else if (name == "KeepList") {
914 // Incrementally sent list
915 std::string listname;
916 std::getline(iss, listname, ' ');
918 InventoryList *list = getList(listname);
920 new_lists.push_back(list);
922 errorstream << "Inventory::deSerialize(): Tried to keep list '" <<
923 listname << "' which is non-existent." << std::endl;
926 // Any additional fields will throw errors when received by a client
927 // older than PROTOCOL_VERSION 38
930 // Contents given to deSerialize() were not terminated properly: throw error.
932 std::ostringstream ss;
933 ss << "Malformatted inventory (damaged?). "
934 << m_lists.size() << " lists read." << std::endl;
935 throw SerializationError(ss.str());
938 InventoryList * Inventory::addList(const std::string &name, u32 size)
941 s32 i = getListIndex(name);
944 if(m_lists[i]->getSize() != size)
947 m_lists[i] = new InventoryList(name, size, m_itemdef);
948 m_lists[i]->setModified();
954 //don't create list with invalid name
955 if (name.find(' ') != std::string::npos)
958 InventoryList *list = new InventoryList(name, size, m_itemdef);
960 m_lists.push_back(list);
964 InventoryList * Inventory::getList(const std::string &name)
966 s32 i = getListIndex(name);
972 std::vector<const InventoryList*> Inventory::getLists()
974 std::vector<const InventoryList*> lists;
975 lists.reserve(m_lists.size());
976 for (auto list : m_lists) {
977 lists.push_back(list);
982 bool Inventory::deleteList(const std::string &name)
984 s32 i = getListIndex(name);
990 m_lists.erase(m_lists.begin() + i);
994 const InventoryList *Inventory::getList(const std::string &name) const
996 s32 i = getListIndex(name);
1002 const s32 Inventory::getListIndex(const std::string &name) const
1004 for(u32 i=0; i<m_lists.size(); i++)
1006 if(m_lists[i]->getName() == name)