/* * The Mana Client * Copyright (C) 2004-2009 The Mana World Development Team * Copyright (C) 2009-2012 The Mana Developers * * This file is part of The Mana Client. * * 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 * 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, see . */ #include "resources/mapreader.h" #include "configuration.h" #include "log.h" #include "map.h" #include "tileset.h" #include "resources/animation.h" #include "resources/image.h" #include "resources/resourcemanager.h" #include "utils/base64.h" #include "utils/stringutils.h" #include "utils/xml.h" #include "utils/zlib.h" #include // DO NOT CHANGE THESE STRINGS TO BE PASSED BY REFERENCE, AS THIS METHOD ALTERS // (THAT IS, DESTROYS) THEM. static std::string resolveRelativePath(std::string base, std::string relative) { // Remove trailing "/", if present size_t i = base.length(); if (base.at(i - 1) == '/') base.erase(i - 1, i); while (relative.substr(0, 3) == "../") { relative.erase(0, 3); // Remove "../" if (!base.empty()) // If base is already empty, we can't trim anymore { i = base.find_last_of('/'); if (i == std::string::npos) i = 0; base.erase(i, base.length()); // Remove deepest folder in base } } // Re-add trailing slash, if needed if (!base.empty() && base[base.length() - 1] != '/') base += '/'; return base + relative; } Map *MapReader::readMap(const std::string &filename) { logger->log("Attempting to read map %s", filename.c_str()); Map *map = nullptr; XML::Document doc(filename); xmlNodePtr node = doc.rootNode(); // Parse the inflated map data if (node) { if (!xmlStrEqual(node->name, BAD_CAST "map")) { logger->log("Error: Not a map file (%s)!", filename.c_str()); } else { map = readMap(node, filename); } } else { logger->log("Error while parsing map file (%s)!", filename.c_str()); } if (map) map->setProperty("_filename", filename); return map; } Map *MapReader::readMap(xmlNodePtr node, const std::string &path) { // Take the filename off the path const std::string pathDir = path.substr(0, path.rfind("/") + 1); const int w = XML::getProperty(node, "width", 0); const int h = XML::getProperty(node, "height", 0); const int tilew = XML::getProperty(node, "tilewidth", -1); const int tileh = XML::getProperty(node, "tileheight", -1); if (tilew < 0 || tileh < 0) { logger->log("MapReader: Warning: " "Unitialized tile width or height value for map: %s", path.c_str()); return nullptr; } Map *map = new Map(w, h, tilew, tileh); for_each_xml_child_node(childNode, node) { if (xmlStrEqual(childNode->name, BAD_CAST "tileset")) { Tileset *tileset = readTileset(childNode, pathDir, map); if (tileset) { map->addTileset(tileset); } } else if (xmlStrEqual(childNode->name, BAD_CAST "layer")) { readLayer(childNode, map); } else if (xmlStrEqual(childNode->name, BAD_CAST "properties")) { readProperties(childNode, map); } else if (xmlStrEqual(childNode->name, BAD_CAST "objectgroup")) { // The object group offset is applied to each object individually const int tileOffsetX = XML::getProperty(childNode, "x", 0); const int tileOffsetY = XML::getProperty(childNode, "y", 0); const int offsetX = tileOffsetX * tilew; const int offsetY = tileOffsetY * tileh; for_each_xml_child_node(objectNode, childNode) { if (xmlStrEqual(objectNode->name, BAD_CAST "object")) { std::string objType = XML::getProperty(objectNode, "type", ""); objType = toUpper(objType); if (objType == "NPC" || objType == "SCRIPT" || objType == "SPAWN") { // Silently skip server-side objects. continue; } const std::string objName = XML::getProperty(objectNode, "name", ""); const int objX = XML::getProperty(objectNode, "x", 0); const int objY = XML::getProperty(objectNode, "y", 0); const int objW = XML::getProperty(objectNode, "width", 0); const int objH = XML::getProperty(objectNode, "height", 0); logger->log("- Loading object name: %s type: %s at %d:%d", objName.c_str(), objType.c_str(), objX, objY); if (objType == "PARTICLE_EFFECT") { if (objName.empty()) { logger->log(" Warning: No particle file given"); continue; } map->addParticleEffect(objName, objX + offsetX, objY + offsetY, objW, objH); } else if (objType == "WARP") { if (config.getValue("showWarps", 1)) { map->addParticleEffect( paths.getStringValue("particles") + paths.getStringValue("portalEffectFile"), objX, objY, objW, objH); } } else { logger->log(" Warning: Unknown object type"); } } } } } map->initializeAmbientLayers(); return map; } void MapReader::readProperties(xmlNodePtr node, Properties *props) { for_each_xml_child_node(childNode, node) { if (!xmlStrEqual(childNode->name, BAD_CAST "property")) continue; // Example: const std::string name = XML::getProperty(childNode, "name", ""); const std::string value = XML::getProperty(childNode, "value", ""); if (!name.empty() && !value.empty()) props->setProperty(name, value); } } static void setTile(Map *map, MapLayer *layer, int x, int y, unsigned gid) { // Bits on the far end of the 32-bit global tile ID are used for tile flags const int FlippedHorizontallyFlag = 0x80000000; const int FlippedVerticallyFlag = 0x40000000; const int FlippedAntiDiagonallyFlag = 0x20000000; // Clear the flags // TODO: It would be nice to properly support these flags later gid &= ~(FlippedHorizontallyFlag | FlippedVerticallyFlag | FlippedAntiDiagonallyFlag); const Tileset * const set = map->getTilesetWithGid(gid); if (layer) { // Set regular tile on a layer Image * const img = set ? set->get(gid - set->getFirstGid()) : nullptr; layer->setTile(x, y, img); } else { // Set collision tile if (set && (gid - set->getFirstGid() == 1)) map->blockTile(x, y, Map::BLOCKTYPE_WALL); } } void MapReader::readLayer(xmlNodePtr node, Map *map) { // Layers are not necessarily the same size as the map const int w = XML::getProperty(node, "width", map->getWidth()); const int h = XML::getProperty(node, "height", map->getHeight()); const int offsetX = XML::getProperty(node, "x", 0); const int offsetY = XML::getProperty(node, "y", 0); std::string name = XML::getProperty(node, "name", ""); name = toLower(name); const bool isFringeLayer = (name.substr(0,6) == "fringe"); const bool isCollisionLayer = (name.substr(0,9) == "collision"); MapLayer *layer = nullptr; if (!isCollisionLayer) { layer = new MapLayer(offsetX, offsetY, w, h, isFringeLayer, map); map->addLayer(layer); } logger->log("- Loading layer \"%s\"", name.c_str()); int x = 0; int y = 0; // Load the tile data for_each_xml_child_node(childNode, node) { if (xmlStrEqual(childNode->name, BAD_CAST "properties")) { for_each_xml_child_node(prop, childNode) { if (!xmlStrEqual(prop->name, BAD_CAST "property")) continue; const std::string pname = XML::getProperty(prop, "name", ""); const std::string value = XML::getProperty(prop, "value", ""); // TODO: Consider supporting "Hidden", "Version" and "NotVersion" if (pname == "Mask") { layer->setMask(atoi(value.c_str())); } } continue; } if (!xmlStrEqual(childNode->name, BAD_CAST "data")) continue; const std::string encoding = XML::getProperty(childNode, "encoding", ""); const std::string compression = XML::getProperty(childNode, "compression", ""); if (encoding == "base64") { if (!compression.empty() && compression != "gzip" && compression != "zlib") { logger->log("Warning: only gzip or zlib layer " "compression supported!"); return; } // Read base64 encoded map file xmlNodePtr dataChild = childNode->xmlChildrenNode; if (!dataChild) continue; int len = strlen((const char*)dataChild->content) + 1; auto *charData = new unsigned char[len + 1]; const char *charStart = (const char*) xmlNodeGetContent(dataChild); unsigned char *charIndex = charData; while (*charStart) { if (*charStart != ' ' && *charStart != '\t' && *charStart != '\n') { *charIndex = *charStart; charIndex++; } charStart++; } *charIndex = '\0'; int binLen; unsigned char *binData = php3_base64_decode(charData, strlen((char*)charData), &binLen); delete[] charData; if (binData) { if (compression == "gzip" || compression == "zlib") { // Inflate the gzipped layer data unsigned char *inflated; unsigned int inflatedSize = inflateMemory(binData, binLen, inflated); free(binData); binData = inflated; binLen = inflatedSize; if (!inflated) { logger->log("Error: Could not decompress layer!"); return; } } for (int i = 0; i < binLen - 3; i += 4) { const unsigned gid = binData[i] | binData[i + 1] << 8 | binData[i + 2] << 16 | binData[i + 3] << 24; setTile(map, layer, x, y, gid); TileAnimation* ani = map->getAnimationForGid(gid); if (ani) { ani->addAffectedTile(layer, x + y * w); } x++; if (x == w) { x = 0; y++; // When we're done, don't crash on too much data if (y == h) break; } } free(binData); } } else if (encoding == "csv") { xmlNodePtr dataChild = childNode->xmlChildrenNode; if (!dataChild) continue; const char *data = (const char*) xmlNodeGetContent(dataChild); std::string csv(data); size_t pos = 0; size_t oldPos = 0; while (oldPos != csv.npos) { pos = csv.find_first_of(",", oldPos); unsigned gid = atol(csv.substr(oldPos, pos - oldPos).c_str()); setTile(map, layer, x, y, gid); x++; if (x == w) { x = 0; y++; // When we're done, don't crash on too much data if (y == h) break; } oldPos = pos + 1; } } else { // Read plain XML map file for_each_xml_child_node(childNode2, childNode) { if (!xmlStrEqual(childNode2->name, BAD_CAST "tile")) continue; unsigned gid = XML::getProperty(childNode2, "gid", 0); setTile(map, layer, x, y, gid); x++; if (x == w) { x = 0; y++; if (y >= h) break; } } } if (y < h) std::cerr << "TOO SMALL!\n"; if (x) std::cerr << "TOO SMALL!\n"; // There can be only one data element break; } } Tileset *MapReader::readTileset(xmlNodePtr node, const std::string &path, Map *map) { unsigned firstGid = XML::getProperty(node, "firstgid", 0); int margin = XML::getProperty(node, "margin", 0); int spacing = XML::getProperty(node, "spacing", 0); XML::Document* doc = nullptr; Tileset *set = nullptr; std::string pathDir(path); if (xmlHasProp(node, BAD_CAST "source")) { std::string filename = XML::getProperty(node, "source", ""); filename = resolveRelativePath(path, filename); doc = new XML::Document(filename); node = doc->rootNode(); // Reset path to be realtive to the tsx file pathDir = filename.substr(0, filename.rfind("/") + 1); } const int tw = XML::getProperty(node, "tilewidth", map->getTileWidth()); const int th = XML::getProperty(node, "tileheight", map->getTileHeight()); for_each_xml_child_node(childNode, node) { if (xmlStrEqual(childNode->name, BAD_CAST "image")) { const std::string source = XML::getProperty(childNode, "source", ""); if (!source.empty()) { std::string sourceStr = resolveRelativePath(pathDir, source); ResourceManager *resman = ResourceManager::getInstance(); Image* tilebmp = resman->getImage(sourceStr); if (tilebmp) { set = new Tileset(tilebmp, tw, th, firstGid, margin, spacing); tilebmp->decRef(); } else { logger->log("Warning: Failed to load tileset (%s)", source.c_str()); } } } else if (xmlStrEqual(childNode->name, BAD_CAST "tile")) { for_each_xml_child_node(tileNode, childNode) { if (!xmlStrEqual(tileNode->name, BAD_CAST "properties")) continue; int tileGID = firstGid + XML::getProperty(childNode, "id", 0); // read tile properties to a map for simpler handling std::map tileProperties; for_each_xml_child_node(propertyNode, tileNode) { if (!xmlStrEqual(propertyNode->name, BAD_CAST "property")) continue; std::string name = XML::getProperty(propertyNode, "name", ""); int value = XML::getProperty(propertyNode, "value", 0); tileProperties[name] = value; logger->log("Tile Prop of %d \"%s\" = \"%d\"", tileGID, name.c_str(), value); } // create animation if (!set) continue; auto *ani = new Animation; for (int i = 0; ;i++) { std::map::iterator iFrame, iDelay; iFrame = tileProperties.find("animation-frame" + toString(i)); iDelay = tileProperties.find("animation-delay" + toString(i)); if (iFrame != tileProperties.end() && iDelay != tileProperties.end()) ani->addFrame(set->get(iFrame->second), iDelay->second, 0, 0); else break; } if (ani->getLength() > 0) { map->addAnimation(tileGID, new TileAnimation(ani)); logger->log("Animation length: %d", ani->getLength()); } else { delete ani; } } } } delete doc; return set; }