Copyright (C) 2010 celeron55, Perttu Ahola <celeron55@gmail.com>
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
+it under the terms of the GNU Lesser General Public License as published by
+the Free Software Foundation; either version 2.1 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.
+GNU Lesser General Public License for more details.
-You should have received a copy of the GNU General Public License along
+You should have received a copy of the GNU Lesser General Public License along
with this program; if not, write to the Free Software Foundation, Inc.,
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*/
#include "client.h"
-#include "utility.h"
#include <iostream>
#include "clientserver.h"
#include "jmutexautolock.h"
#include "clientmap.h"
#include "filecache.h"
#include "sound.h"
+#include "util/string.h"
+#include "hex.h"
-static std::string getTextureCacheDir()
+static std::string getMediaCacheDir()
{
- return porting::path_user + DIR_DELIM + "cache" + DIR_DELIM + "textures";
+ return porting::path_user + DIR_DELIM + "cache" + DIR_DELIM + "media";
}
-struct TextureRequest
+struct MediaRequest
{
std::string name;
- TextureRequest(const std::string &name_=""):
+ MediaRequest(const std::string &name_=""):
name(name_)
{}
};
m_map_seed(0),
m_password(password),
m_access_denied(false),
- m_texture_cache(getTextureCacheDir()),
- m_texture_receive_progress(0),
- m_textures_received(false),
+ m_media_cache(getMediaCacheDir()),
+ m_media_receive_progress(0),
+ m_media_received(false),
m_itemdef_received(false),
m_nodedef_received(false),
m_time_of_day_set(false),
sleep_ms(100);
delete m_inventory_from_server;
+
+ // Delete detached inventories
+ {
+ for(std::map<std::string, Inventory*>::iterator
+ i = m_detached_inventories.begin();
+ i != m_detached_inventories.end(); i++){
+ delete i->second;
+ }
+ }
}
void Client::connect(Address address)
}
}
+bool Client::loadMedia(const std::string &data, const std::string &filename)
+{
+ // Silly irrlicht's const-incorrectness
+ Buffer<char> data_rw(data.c_str(), data.size());
+
+ std::string name;
+
+ const char *image_ext[] = {
+ ".png", ".jpg", ".bmp", ".tga",
+ ".pcx", ".ppm", ".psd", ".wal", ".rgb",
+ NULL
+ };
+ name = removeStringEnd(filename, image_ext);
+ if(name != "")
+ {
+ verbosestream<<"Client: Attempting to load image "
+ <<"file \""<<filename<<"\""<<std::endl;
+
+ io::IFileSystem *irrfs = m_device->getFileSystem();
+ video::IVideoDriver *vdrv = m_device->getVideoDriver();
+
+ // Create an irrlicht memory file
+ io::IReadFile *rfile = irrfs->createMemoryReadFile(
+ *data_rw, data_rw.getSize(), "_tempreadfile");
+ assert(rfile);
+ // Read image
+ video::IImage *img = vdrv->createImageFromFile(rfile);
+ if(!img){
+ errorstream<<"Client: Cannot create image from data of "
+ <<"file \""<<filename<<"\""<<std::endl;
+ rfile->drop();
+ return false;
+ }
+ else {
+ m_tsrc->insertSourceImage(filename, img);
+ img->drop();
+ rfile->drop();
+ return true;
+ }
+ }
+
+ const char *sound_ext[] = {
+ ".0.ogg", ".1.ogg", ".2.ogg", ".3.ogg", ".4.ogg",
+ ".5.ogg", ".6.ogg", ".7.ogg", ".8.ogg", ".9.ogg",
+ ".ogg", NULL
+ };
+ name = removeStringEnd(filename, sound_ext);
+ if(name != "")
+ {
+ verbosestream<<"Client: Attempting to load sound "
+ <<"file \""<<filename<<"\""<<std::endl;
+ m_sound->loadSoundData(name, data);
+ return true;
+ }
+
+ errorstream<<"Client: Don't know how to load file \""
+ <<filename<<"\""<<std::endl;
+ return false;
+}
+
// Virtual methods from con::PeerHandler
void Client::peerAdded(con::Peer *peer)
{
}
else if(command == TOCLIENT_PLAYERITEM)
{
- std::string datastring((char*)&data[2], datasize-2);
- std::istringstream is(datastring, std::ios_base::binary);
-
- u16 count = readU16(is);
-
- for (u16 i = 0; i < count; ++i) {
- u16 peer_id = readU16(is);
- Player *player = m_env.getPlayer(peer_id);
-
- if (player == NULL)
- {
- infostream<<"Client: ignoring player item "
- << deSerializeString(is)
- << " for non-existing peer id " << peer_id
- << std::endl;
- continue;
- } else if (player->isLocal()) {
- infostream<<"Client: ignoring player item "
- << deSerializeString(is)
- << " for local player" << std::endl;
- continue;
- } else {
- InventoryList *inv = player->inventory.getList("main");
- std::string itemstring(deSerializeString(is));
- ItemStack item;
- item.deSerialize(itemstring, m_itemdef);
- inv->changeItem(0, item);
- if(itemstring.empty())
- {
- infostream<<"Client: empty player item for peer "
- <<peer_id<<std::endl;
- }
- else
- {
- infostream<<"Client: player item for peer "
- <<peer_id<<": "<<itemstring<<std::endl;
- }
- }
- }
+ infostream<<"Client: WARNING: Ignoring TOCLIENT_PLAYERITEM"<<std::endl;
}
else if(command == TOCLIENT_DEATHSCREEN)
{
event.deathscreen.camera_point_target_z = camera_point_target.Z;
m_client_event_queue.push_back(event);
}
- else if(command == TOCLIENT_ANNOUNCE_TEXTURES)
+ else if(command == TOCLIENT_ANNOUNCE_MEDIA)
{
- io::IFileSystem *irrfs = m_device->getFileSystem();
- video::IVideoDriver *vdrv = m_device->getVideoDriver();
-
std::string datastring((char*)&data[2], datasize-2);
std::istringstream is(datastring, std::ios_base::binary);
// updating content definitions
assert(!m_mesh_update_thread.IsRunning());
- int num_textures = readU16(is);
-
- core::list<TextureRequest> texture_requests;
-
- for(int i=0; i<num_textures; i++){
+ int num_files = readU16(is);
+
+ verbosestream<<"Client received TOCLIENT_ANNOUNCE_MEDIA ("
+ <<num_files<<" files)"<<std::endl;
- bool texture_found = false;
+ core::list<MediaRequest> file_requests;
- //read texture from cache
+ for(int i=0; i<num_files; i++)
+ {
+ //read file from cache
std::string name = deSerializeString(is);
- std::string sha1_texture = deSerializeString(is);
+ std::string sha1_base64 = deSerializeString(is);
- // if name contains illegal characters, ignore the texture
+ // if name contains illegal characters, ignore the file
if(!string_allowed(name, TEXTURENAME_ALLOWED_CHARS)){
- errorstream<<"Client: ignoring illegal texture name "
+ errorstream<<"Client: ignoring illegal file name "
<<"sent by server: \""<<name<<"\""<<std::endl;
continue;
}
- std::string sha1_decoded = base64_decode(sha1_texture);
+ std::string sha1_raw = base64_decode(sha1_base64);
+ std::string sha1_hex = hex_encode(sha1_raw);
std::ostringstream tmp_os(std::ios_base::binary);
- bool tex_in_cache = m_texture_cache.loadByChecksum(name,
- tmp_os, sha1_decoded);
- m_texture_name_sha1_map.set(name, sha1_decoded);
-
- if(tex_in_cache) {
-
- SHA1 sha1;
- sha1.addBytes(tmp_os.str().c_str(), tmp_os.str().length());
-
- unsigned char *digest = sha1.getDigest();
-
- std::string digest_string = base64_encode(digest, 20);
-
- if (digest_string == sha1_texture) {
- // Silly irrlicht's const-incorrectness
- Buffer<char> data_rw(tmp_os.str().c_str(), tmp_os.str().size());
+ bool found_in_cache = m_media_cache.load_sha1(sha1_raw, tmp_os);
+ m_media_name_sha1_map.set(name, sha1_raw);
- // Create an irrlicht memory file
- io::IReadFile *rfile = irrfs->createMemoryReadFile(
- *data_rw, tmp_os.str().size(), "_tempreadfile");
- assert(rfile);
- // Read image
- video::IImage *img = vdrv->createImageFromFile(rfile);
- if(!img){
- infostream<<"Client: Cannot create image from data of "
- <<"received texture \""<<name<<"\""<<std::endl;
- rfile->drop();
- }
- else {
- m_tsrc->insertSourceImage(name, img);
- img->drop();
- rfile->drop();
-
- texture_found = true;
- }
- }
- else {
- infostream<<"Client::Texture cached sha1 hash not matching server hash: "
- <<name << ": server ->"<<sha1_texture <<" client -> "<<digest_string<<std::endl;
+ // If found in cache, try to load it from there
+ if(found_in_cache)
+ {
+ bool success = loadMedia(tmp_os.str(), name);
+ if(success){
+ verbosestream<<"Client: Loaded cached media: "
+ <<sha1_hex<<" \""<<name<<"\""<<std::endl;
+ continue;
+ } else{
+ infostream<<"Client: Failed to load cached media: "
+ <<sha1_hex<<" \""<<name<<"\""<<std::endl;
}
-
- free(digest);
- }
-
- //add texture request
- if (!texture_found) {
- infostream<<"Client: Adding texture to request list: \""
- <<name<<"\""<<std::endl;
- texture_requests.push_back(TextureRequest(name));
}
-
+ // Didn't load from cache; queue it to be requested
+ verbosestream<<"Client: Adding file to request list: \""
+ <<sha1_hex<<" \""<<name<<"\""<<std::endl;
+ file_requests.push_back(MediaRequest(name));
}
ClientEvent event;
event.type = CE_TEXTURES_UPDATED;
m_client_event_queue.push_back(event);
-
- //send Texture request
/*
- u16 command
- u16 number of textures requested
- for each texture {
- u16 length of name
- string name
- }
- */
+ u16 command
+ u16 number of files requested
+ for each file {
+ u16 length of name
+ string name
+ }
+ */
std::ostringstream os(std::ios_base::binary);
- u8 buf[12];
+ writeU16(os, TOSERVER_REQUEST_MEDIA);
+ writeU16(os, file_requests.size());
-
- // Write command
- writeU16(buf, TOSERVER_REQUEST_TEXTURES);
- os.write((char*)buf, 2);
-
- writeU16(buf,texture_requests.size());
- os.write((char*)buf, 2);
-
-
- for(core::list<TextureRequest>::Iterator i = texture_requests.begin();
- i != texture_requests.end(); i++) {
+ for(core::list<MediaRequest>::Iterator i = file_requests.begin();
+ i != file_requests.end(); i++) {
os<<serializeString(i->name);
}
SharedBuffer<u8> data((u8*)s.c_str(), s.size());
// Send as reliable
Send(0, data, true);
- infostream<<"Client: Sending request list to server " <<std::endl;
+ infostream<<"Client: Sending media request list to server ("
+ <<file_requests.size()<<" files)"<<std::endl;
}
- else if(command == TOCLIENT_TEXTURES)
+ else if(command == TOCLIENT_MEDIA)
{
- io::IFileSystem *irrfs = m_device->getFileSystem();
- video::IVideoDriver *vdrv = m_device->getVideoDriver();
-
std::string datastring((char*)&data[2], datasize-2);
std::istringstream is(datastring, std::ios_base::binary);
/*
u16 command
- u16 total number of texture bunches
+ u16 total number of file bunches
u16 index of this bunch
- u32 number of textures in this bunch
- for each texture {
+ u32 number of files in this bunch
+ for each file {
u16 length of name
string name
u32 length of data
*/
int num_bunches = readU16(is);
int bunch_i = readU16(is);
- m_texture_receive_progress = (float)bunch_i / (float)(num_bunches - 1);
+ if(num_bunches >= 2)
+ m_media_receive_progress = (float)bunch_i / (float)(num_bunches - 1);
+ else
+ m_media_receive_progress = 1.0;
if(bunch_i == num_bunches - 1)
- m_textures_received = true;
- int num_textures = readU32(is);
- infostream<<"Client: Received textures: bunch "<<bunch_i<<"/"
- <<num_bunches<<" textures="<<num_textures
+ m_media_received = true;
+ int num_files = readU32(is);
+ infostream<<"Client: Received files: bunch "<<bunch_i<<"/"
+ <<num_bunches<<" files="<<num_files
<<" size="<<datasize<<std::endl;
- for(int i=0; i<num_textures; i++){
+ for(int i=0; i<num_files; i++){
std::string name = deSerializeString(is);
std::string data = deSerializeLongString(is);
- // if name contains illegal characters, ignore the texture
+ // if name contains illegal characters, ignore the file
if(!string_allowed(name, TEXTURENAME_ALLOWED_CHARS)){
- errorstream<<"Client: ignoring illegal texture name "
+ errorstream<<"Client: ignoring illegal file name "
<<"sent by server: \""<<name<<"\""<<std::endl;
continue;
}
-
- // Silly irrlicht's const-incorrectness
- Buffer<char> data_rw(data.c_str(), data.size());
- // Create an irrlicht memory file
- io::IReadFile *rfile = irrfs->createMemoryReadFile(
- *data_rw, data.size(), "_tempreadfile");
- assert(rfile);
- // Read image
- video::IImage *img = vdrv->createImageFromFile(rfile);
- if(!img){
- errorstream<<"Client: Cannot create image from data of "
- <<"received texture \""<<name<<"\""<<std::endl;
- rfile->drop();
+
+ bool success = loadMedia(data, name);
+ if(success){
+ verbosestream<<"Client: Loaded received media: "
+ <<"\""<<name<<"\". Caching."<<std::endl;
+ } else{
+ infostream<<"Client: Failed to load received media: "
+ <<"\""<<name<<"\". Not caching."<<std::endl;
continue;
}
- fs::CreateAllDirs(getTextureCacheDir());
+ bool did = fs::CreateAllDirs(getMediaCacheDir());
+ if(!did){
+ errorstream<<"Could not create media cache directory"
+ <<std::endl;
+ }
{
core::map<std::string, std::string>::Node *n;
- n = m_texture_name_sha1_map.find(name);
+ n = m_media_name_sha1_map.find(name);
if(n == NULL)
- errorstream<<"The server sent a texture that has not been announced."
- <<std::endl;
+ errorstream<<"The server sent a file that has not "
+ <<"been announced."<<std::endl;
else
- m_texture_cache.updateByChecksum(name,
- data, n->getValue());
+ m_media_cache.update_sha1(data);
}
-
- m_tsrc->insertSourceImage(name, img);
- img->drop();
- rfile->drop();
}
ClientEvent event;
int client_id = -1;
switch(type){
case 0: // local
- client_id = m_sound->playSound(name, false, gain);
+ client_id = m_sound->playSound(name, loop, gain);
break;
case 1: // positional
- client_id = m_sound->playSoundAt(name, false, gain, pos);
+ client_id = m_sound->playSoundAt(name, loop, gain, pos);
break;
case 2: { // object
ClientActiveObject *cao = m_env.getActiveObject(object_id);
m_sound->stopSound(client_id);
}
}
+ else if(command == TOCLIENT_PRIVILEGES)
+ {
+ std::string datastring((char*)&data[2], datasize-2);
+ std::istringstream is(datastring, std::ios_base::binary);
+
+ m_privileges.clear();
+ infostream<<"Client: Privileges updated: ";
+ u16 num_privileges = readU16(is);
+ for(u16 i=0; i<num_privileges; i++){
+ std::string priv = deSerializeString(is);
+ m_privileges.insert(priv);
+ infostream<<priv<<" ";
+ }
+ infostream<<std::endl;
+ }
+ else if(command == TOCLIENT_INVENTORY_FORMSPEC)
+ {
+ std::string datastring((char*)&data[2], datasize-2);
+ std::istringstream is(datastring, std::ios_base::binary);
+
+ // Store formspec in LocalPlayer
+ Player *player = m_env.getLocalPlayer();
+ assert(player != NULL);
+ player->inventory_formspec = deSerializeLongString(is);
+ }
+ else if(command == TOCLIENT_DETACHED_INVENTORY)
+ {
+ std::string datastring((char*)&data[2], datasize-2);
+ std::istringstream is(datastring, std::ios_base::binary);
+
+ std::string name = deSerializeString(is);
+
+ infostream<<"Client: Detached inventory update: \""<<name<<"\""<<std::endl;
+
+ Inventory *inv = NULL;
+ if(m_detached_inventories.count(name) > 0)
+ inv = m_detached_inventories[name];
+ else{
+ inv = new Inventory(m_itemdef);
+ m_detached_inventories[name] = inv;
+ }
+ inv->deSerialize(is);
+ }
else
{
infostream<<"Client: Ignoring unknown command "
Send(0, data, true);
}
-void Client::sendSignNodeText(v3s16 p, std::string text)
+void Client::sendNodemetaFields(v3s16 p, const std::string &formname,
+ const std::map<std::string, std::string> &fields)
{
- /*
- u16 command
- v3s16 p
- u16 textlen
- textdata
- */
std::ostringstream os(std::ios_base::binary);
- u8 buf[12];
-
- // Write command
- writeU16(buf, TOSERVER_SIGNNODETEXT);
- os.write((char*)buf, 2);
-
- // Write p
- writeV3S16(buf, p);
- os.write((char*)buf, 6);
- u16 textlen = text.size();
- // Write text length
- writeS16(buf, textlen);
- os.write((char*)buf, 2);
+ writeU16(os, TOSERVER_NODEMETA_FIELDS);
+ writeV3S16(os, p);
+ os<<serializeString(formname);
+ writeU16(os, fields.size());
+ for(std::map<std::string, std::string>::const_iterator
+ i = fields.begin(); i != fields.end(); i++){
+ const std::string &name = i->first;
+ const std::string &value = i->second;
+ os<<serializeString(name);
+ os<<serializeLongString(value);
+ }
- // Write text
- os.write((char*)text.c_str(), textlen);
-
// Make data buffer
std::string s = os.str();
SharedBuffer<u8> data((u8*)s.c_str(), s.size());
Send(0, data, true);
}
+void Client::sendInventoryFields(const std::string &formname,
+ const std::map<std::string, std::string> &fields)
+{
+ std::ostringstream os(std::ios_base::binary);
+
+ writeU16(os, TOSERVER_INVENTORY_FIELDS);
+ os<<serializeString(formname);
+ writeU16(os, fields.size());
+ for(std::map<std::string, std::string>::const_iterator
+ i = fields.begin(); i != fields.end(); i++){
+ const std::string &name = i->first;
+ const std::string &value = i->second;
+ os<<serializeString(name);
+ os<<serializeLongString(value);
+ }
+
+ // Make data buffer
+ std::string s = os.str();
+ SharedBuffer<u8> data((u8*)s.c_str(), s.size());
+ // Send as reliable
+ Send(0, data, true);
+}
+
void Client::sendInventoryAction(InventoryAction *a)
{
std::ostringstream os(std::ios_base::binary);
return meta->getInventory();
}
break;
+ case InventoryLocation::DETACHED:
+ {
+ if(m_detached_inventories.count(loc.name) == 0)
+ return NULL;
+ return m_detached_inventories[loc.name];
+ }
+ break;
default:
assert(0);
}
void Client::afterContentReceived()
{
+ verbosestream<<"Client::afterContentReceived() started"<<std::endl;
assert(m_itemdef_received);
assert(m_nodedef_received);
- assert(m_textures_received);
-
+ assert(m_media_received);
+
// remove the information about which checksum each texture
// ought to have
- m_texture_name_sha1_map.clear();
+ m_media_name_sha1_map.clear();
// Rebuild inherited images and recreate textures
+ verbosestream<<"Rebuilding images and textures"<<std::endl;
m_tsrc->rebuildImagesAndTextures();
// Update texture atlas
+ verbosestream<<"Updating texture atlas"<<std::endl;
if(g_settings->getBool("enable_texture_atlas"))
m_tsrc->buildMainAtlas(this);
// Update node aliases
+ verbosestream<<"Updating node aliases"<<std::endl;
m_nodedef->updateAliases(m_itemdef);
// Update node textures
+ verbosestream<<"Updating node textures"<<std::endl;
m_nodedef->updateTextures(m_tsrc);
// Update item textures and meshes
+ verbosestream<<"Updating item textures and meshes"<<std::endl;
m_itemdef->updateTexturesAndMeshes(this);
// Start mesh update thread after setting up content definitions
+ verbosestream<<"Starting mesh update thread"<<std::endl;
m_mesh_update_thread.Start();
+
+ verbosestream<<"Client::afterContentReceived() done"<<std::endl;
}
float Client::getRTT(void)