Skip to content

Commit

Permalink
campaignd: Refactor construct_message/error() functions and boilerplate
Browse files Browse the repository at this point in the history 
This replaces them with two methods that are part of the server class
itself.

These functions were always used in conjunction with
network::send_data() to send the generated WML object to a network
client. Because the config was created within the functions and not on
the callsite, this resulted in a call to the config copy constructor
that could be avoided by grouping the network::send_data() call together
with the WML generation.

(Backported e535443 from master.)

Conflicts:
	src/campaign_server/campaign_server.cpp
  • Loading branch information
@irydacea
irydacea committed Oct 11, 2014
1 parent 8f6d82b commit 04c97ad
Show file tree
Hide file tree
Showing 2 changed files with 55 additions and 44 deletions.
89 changes: 45 additions & 44 deletions src/campaign_server/campaign_server.cpp
View file
Expand Up @@ -152,21 +152,6 @@ namespace {

return std::string();
}

config construct_message(const std::string& msg)
{
config cfg;
cfg.add_child("message")["message"] = msg;
return cfg;
}

config construct_error(const std::string& msg)
{
config cfg;
cfg.add_child("error")["message"] = msg;
LOG_CS << "ERROR: "<<msg<<"\n";
return cfg;
}
} // end anonymous namespace 1

namespace campaignd {
Expand Down Expand Up @@ -310,6 +295,21 @@ void server::fire(const std::string& hook, const std::string& addon)
#endif
}

void server::send_message(const std::string& msg, network::connection sock)
{
config cfg;
cfg.add_child("message")["message"] = msg;
network::send_data(cfg, sock);
}

void server::send_error(const std::string& msg, network::connection sock)
{
config cfg;
cfg.add_child("error")["message"] = msg;
LOG_CS << "ERROR: " << msg << '\n';
network::send_data(cfg, sock);
}

} // end namespace campaignd

namespace {
Expand Down Expand Up @@ -526,14 +526,14 @@ void server::handle_request_campaign(const server::request& req)
LOG_CS << "sending campaign '" << req.cfg["name"] << "' to " << req.addr << " using gzip";
config &campaign = campaigns().find_child("campaign", "name", req.cfg["name"]);
if (!campaign) {
network::send_data(construct_error("Add-on '" + req.cfg["name"].str() + "' not found."), req.sock);
send_error("Add-on '" + req.cfg["name"].str() + "' not found.", req.sock);
} else {
const int size = file_size(campaign["filename"]);

if(size < 0) {
std::cerr << " size: <unknown> KiB\n";
LOG_CS << "File size unknown, aborting send.\n";
network::send_data(construct_error("Add-on '" + req.cfg["name"].str() + "' could not be read by the server."), req.sock);
send_error("Add-on '" + req.cfg["name"].str() + "' could not be read by the server.", req.sock);
return;
}

Expand All @@ -555,12 +555,12 @@ void server::handle_request_terms(const server::request& req)
// to give up when we're in read-only mode.
if(read_only_) {
LOG_CS << "in read-only mode, request for upload terms denied\n";
network::send_data(construct_error("The server is currently in read-only mode, add-on uploads are disabled."), req.sock);
send_error("The server is currently in read-only mode, add-on uploads are disabled.", req.sock);
return;
}

LOG_CS << "sending terms " << req.addr << "\n";
network::send_data(construct_message("All add-ons uploaded to this server must be licensed under the terms of the GNU General Public License (GPL). By uploading content to this server, you certify that you have the right to place the content under the conditions of the GPL, and choose to do so."), req.sock);
send_message("All add-ons uploaded to this server must be licensed under the terms of the GNU General Public License (GPL). By uploading content to this server, you certify that you have the right to place the content under the conditions of the GPL, and choose to do so.", req.sock);
LOG_CS << " Done\n";
}

Expand All @@ -584,44 +584,45 @@ void server::handle_upload(const server::request& req)

if (read_only_) {
LOG_CS << "Upload aborted - uploads not permitted in read-only mode.\n";
network::send_data(construct_error("Add-on rejected: The server is currently in read-only mode."), req.sock);
send_error("Add-on rejected: The server is currently in read-only mode.", req.sock);
} else if (!data) {
LOG_CS << "Upload aborted - no add-on data.\n";
network::send_data(construct_error("Add-on rejected: No add-on data was supplied."), req.sock);
send_error("Add-on rejected: No add-on data was supplied.", req.sock);
} else if (!addon_name_legal(upload["name"])) {
LOG_CS << "Upload aborted - invalid add-on name.\n";
network::send_data(construct_error("Add-on rejected: The name of the add-on is invalid."), req.sock);
send_error("Add-on rejected: The name of the add-on is invalid.", req.sock);
} else if (is_text_markup_char(upload["name"].str()[0])) {
LOG_CS << "Upload aborted - add-on name starts with an illegal formatting character.\n";
network::send_data(construct_error("Add-on rejected: The name of the add-on starts with an illegal formatting character."), req.sock);
send_error("Add-on rejected: The name of the add-on starts with an illegal formatting character.", req.sock);
} else if (upload["title"].empty()) {
LOG_CS << "Upload aborted - no add-on title specified.\n";
network::send_data(construct_error("Add-on rejected: You did not specify the title of the add-on in the pbl file!"), req.sock);
send_error("Add-on rejected: You did not specify the title of the add-on in the pbl file!", req.sock);
} else if (is_text_markup_char(upload["title"].str()[0])) {
LOG_CS << "Upload aborted - add-on title starts with an illegal formatting character.\n";
network::send_data(construct_error("Add-on rejected: The title of the add-on starts with an illegal formatting character."), req.sock);
send_error("Add-on rejected: The title of the add-on starts with an illegal formatting character.", req.sock);
} else if (get_addon_type(upload["type"]) == ADDON_UNKNOWN) {
LOG_CS << "Upload aborted - unknown add-on type specified.\n";
network::send_data(construct_error("Add-on rejected: You did not specify a known type for the add-on in the pbl file! (See PblWML: wiki.wesnoth.org/PblWML)"), req.sock);
send_error("Add-on rejected: You did not specify a known type for the add-on in the pbl file! (See PblWML: wiki.wesnoth.org/PblWML)", req.sock);
} else if (upload["author"].empty()) {
LOG_CS << "Upload aborted - no add-on author specified.\n";
network::send_data(construct_error("Add-on rejected: You did not specify the author(s) of the add-on in the pbl file!"), req.sock);
send_error("Add-on rejected: You did not specify the author(s) of the add-on in the pbl file!", req.sock);
} else if (upload["version"].empty()) {
LOG_CS << "Upload aborted - no add-on version specified.\n";
network::send_data(construct_error("Add-on rejected: You did not specify the version of the add-on in the pbl file!"), req.sock);
send_error("Add-on rejected: You did not specify the version of the add-on in the pbl file!", req.sock);
} else if (upload["description"].empty()) {
LOG_CS << "Upload aborted - no add-on description specified.\n";
network::send_data(construct_error("Add-on rejected: You did not specify a description of the add-on in the pbl file!"), req.sock);
send_error("Add-on rejected: You did not specify a description of the add-on in the pbl file!", req.sock);
} else if (upload["email"].empty()) {
LOG_CS << "Upload aborted - no add-on email specified.\n";
network::send_data(construct_error("Add-on rejected: You did not specify your email address in the pbl file!"), req.sock);
send_error("Add-on rejected: You did not specify your email address in the pbl file!", req.sock);
} else if (!check_names_legal(data)) {
LOG_CS << "Upload aborted - invalid file names in add-on data.\n";
network::send_data(construct_error("Add-on rejected: The add-on contains an illegal file or directory name."
" File or directory names may not contain whitespace or any of the following characters: '/ \\ : ~'"), req.sock);
send_error("Add-on rejected: The add-on contains an illegal file or directory name."
" File or directory names may not contain whitespace or any of the following characters: '/ \\ : ~'",
req.sock);
} else if (campaign && (*campaign)["passphrase"].str() != upload["passphrase"]) {
LOG_CS << "Upload aborted - incorrect passphrase.\n";
network::send_data(construct_error("Add-on rejected: The add-on already exists, and your passphrase was incorrect."), req.sock);
send_error("Add-on rejected: The add-on already exists, and your passphrase was incorrect.", req.sock);
} else {
const time_t upload_ts = time(NULL);

Expand All @@ -635,7 +636,7 @@ void server::handle_upload(const server::request& req)
upload["email"].str()))
{
LOG_CS << "Upload denied - blacklisted add-on information.\n";
network::send_data(construct_error("Add-on upload denied. Please contact the server administration for assistance."), req.sock);
send_error("Add-on upload denied. Please contact the server administration for assistance.", req.sock);
return;
}

Expand Down Expand Up @@ -704,7 +705,7 @@ void server::handle_upload(const server::request& req)

write_config();

network::send_data(construct_message(message), req.sock);
send_message(message, req.sock);

fire("hook_post_upload", upload["name"]);
}
Expand All @@ -716,22 +717,22 @@ void server::handle_delete(const server::request& req)

if(read_only_) {
LOG_CS << "in read-only mode, request to delete '" << erase["name"] << "' from " << req.addr << " denied\n";
network::send_data(construct_error("Cannot delete add-on: The server is currently in read-only mode."), req.sock);
send_error("Cannot delete add-on: The server is currently in read-only mode.", req.sock);
return;
}

LOG_CS << "deleting campaign '" << erase["name"] << "' requested from " << req.addr << "\n";
const config &campaign = campaigns().find_child("campaign", "name", erase["name"]);
if (!campaign) {
network::send_data(construct_error("The add-on does not exist."), req.sock);
send_error("The add-on does not exist.", req.sock);
return;
}

if (campaign["passphrase"] != erase["passphrase"]
&& (campaigns()["master_password"].empty()
|| campaigns()["master_password"] != erase["passphrase"]))
{
network::send_data(construct_error("The passphrase is incorrect."), req.sock);
send_error("The passphrase is incorrect.", req.sock);
return;
}

Expand All @@ -751,7 +752,7 @@ void server::handle_delete(const server::request& req)

write_config();

network::send_data(construct_message("Add-on deleted."), req.sock);
send_message("Add-on deleted.", req.sock);

fire("hook_post_erase", erase["name"]);

Expand All @@ -763,23 +764,23 @@ void server::handle_change_passphrase(const server::request& req)

if(read_only_) {
LOG_CS << "in read-only mode, request to change passphrase denied\n";
network::send_data(construct_error("Cannot change passphrase: The server is currently in read-only mode."), req.sock);
send_error("Cannot change passphrase: The server is currently in read-only mode.", req.sock);
return;
}

config &campaign = campaigns().find_child("campaign", "name", cpass["name"]);
if (!campaign) {
network::send_data(construct_error("No add-on with that name exists."), req.sock);
send_error("No add-on with that name exists.", req.sock);
} else if (campaign["passphrase"] != cpass["passphrase"]) {
network::send_data(construct_error("Your old passphrase was incorrect."), req.sock);
send_error("Your old passphrase was incorrect.", req.sock);
} else if (cpass["new_passphrase"].empty()) {
network::send_data(construct_error("No new passphrase was supplied."), req.sock);
send_error("No new passphrase was supplied.", req.sock);
} else {
campaign["passphrase"] = cpass["new_passphrase"];

write_config();

network::send_data(construct_message("Passphrase changed."), req.sock);
send_message("Passphrase changed.", req.sock);
}
}

Expand Down
10 changes: 10 additions & 0 deletions src/campaign_server/campaign_server.hpp
View file
Expand Up @@ -167,6 +167,16 @@ class server : private boost::noncopyable
void handle_upload(const request&);
void handle_delete(const request&);
void handle_change_passphrase(const request&);

//
// Generic responses.
//

/** Send a client an informational message. */
void send_message(const std::string& msg, network::connection sock);

/** Send a client an error message. */
void send_error(const std::string& msg, network::connection sock);
};

} // end namespace campaignd
Expand Down

0 comments on commit 04c97ad

Please sign in to comment.