winix/winixd/models/itemcontent.cpp

692 lines
16 KiB
C++

/*
* This file is a part of Winix
* and is distributed under the 2-Clause BSD licence.
* Author: Tomasz Sowa <t.sowa@ttmath.org>
*/
/*
* Copyright (c) 2021, Tomasz Sowa
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*
*/
#include "models/itemcontent.h"
#include "core/crypt.h"
#include "core/misc.h"
#include "templates/misc.h"
#include "core/bbcodeparser.h"
#include "core/request.h"
#include "core/users.h"
#include "core/groups.h"
namespace Winix
{
ItemContent::ItemContent()
{
Clear();
}
void ItemContent::fields()
{
int content_raw_type_helper = static_cast<int>(content_raw_type);
int content_parsed_type_helper = static_cast<int>(content_parsed_type);
field(L"id", id, morm::FT::no_insertable | morm::FT::no_updatable | morm::FT::primary_key);
field(L"references", references);
field(L"user_id", user_id);
field(L"group_id", group_id);
field(L"guest_name", guest_name);
field(L"modification_user_id", modification_user_id);
field(L"privileges", privileges);
field(L"date_creation", date_creation);
field(L"date_modification", date_modification);
field(L"link_to", link_to);
field(L"link_redirect", link_redirect);
field(L"file_path", file_path);
field(L"file_fs", file_fs);
field(L"file_type", file_type);
field(L"file_has_thumb", file_has_thumb);
field(L"file_hash", file_hash);
field(L"file_hash_type", file_hash_type);
field(L"file_size", file_size);
field(L"content_raw", content_raw);
field(L"content_raw_type", content_raw_type_helper);
field(L"content_parsed", content_parsed);
field(L"content_parsed_type", content_parsed_type_helper);
field(L"meta", meta);
field(L"admin_meta", admin_meta);
field(L"print_content", &ItemContent::print_content);
field(L"has_static_file", &ItemContent::has_static_file);
field(L"privileges_octal", &ItemContent::privileges_octal);
field(L"has_user", &ItemContent::has_user);
field(L"has_group", &ItemContent::has_group);
field(L"item_users_different", &ItemContent::item_users_different);
field(L"user", &ItemContent::user);
field(L"group", &ItemContent::group);
field(L"type_is", &ItemContent::type_is);
field(L"is_empty", &ItemContent::is_empty);
field(L"file_type_is_none", &ItemContent::file_type_is_none);
field(L"file_type_is_image", &ItemContent::file_type_is_image);
field(L"file_type_is_video", &ItemContent::file_type_is_video);
field(L"file_type_is_sound", &ItemContent::file_type_is_sound);
field(L"has_thumb", &ItemContent::has_thumb);
field(L"display_user_name", &ItemContent::display_user_name);
field(L"is_meta_object", &ItemContent::is_meta_object);
field(L"is_admin_meta_object", &ItemContent::is_admin_meta_object);
field(L"are_dates_equal", &ItemContent::are_dates_equal);
field(L"can_content_be_html_filtered", &ItemContent::CanContentBeHtmlFiltered);
field(L"is_link_to", &ItemContent::is_link_to);
field(L"is_link_redirect", &ItemContent::is_link_redirect);
// IMPROVEME prepare a setter functions which tests whether content_raw_type_helper and content_parsed_type_helper are correct values
content_raw_type = static_cast<ContentType>(content_raw_type_helper);
content_parsed_type = static_cast<ContentType>(content_parsed_type_helper);
}
void ItemContent::table()
{
table_name(L"core", L"content");
}
void ItemContent::after_insert()
{
get_last_sequence_for_primary_key(L"core.content_id_seq", id);
}
// !! IMPROVEME
// now we have Request::start_time and Request::start_date
// we can somehow get the current time from the request
// may setting the date should be completetly removed from here?
void ItemContent::SetDateToNow()
{
date_creation = std::time(0);
date_modification = date_creation;
}
void ItemContent::SetDateModifyToNow()
{
date_modification = std::time(0);
}
void ItemContent::Clear()
{
id = -1;
references = 1;
user_id = -1;
group_id = -1;
guest_name.clear();
modification_user_id = -1;
privileges = 0;
link_to.clear();
link_redirect = false;
file_path.clear();
file_fs = -1;
file_type = WINIX_ITEM_FILETYPE_NONE;
file_has_thumb = false;
file_hash.clear();
file_hash_type = WINIX_CRYPT_HASH_NONE;
file_size = 0;
content_raw.clear();
content_raw_type = ct_formatted_text;
content_parsed.clear();
content_parsed_type = ct_formatted_text;
meta.clear();
admin_meta.clear();
SetDateToNow();
}
bool ItemContent::do_migration(int & current_table_version)
{
bool ok = true;
ok = ok && morm::Model::do_migration(current_table_version, 1, this, &ItemContent::do_migration_to_1);
ok = ok && morm::Model::do_migration(current_table_version, 2, this, &ItemContent::do_migration_to_2);
ok = ok && morm::Model::do_migration(current_table_version, 3, this, &ItemContent::do_migration_to_3);
ok = ok && morm::Model::do_migration(current_table_version, 4, this, &ItemContent::do_migration_to_4);
return ok;
}
bool ItemContent::do_migration_to_1()
{
const char * str = R"sql(
CREATE TABLE core.content (
id serial,
content text,
content_type smallint,
file_path character varying(2048),
file_fs smallint,
file_type smallint,
has_thumb smallint,
ref integer,
modify_index smallint,
hash character varying(255),
hash_type smallint,
file_size bigint
);
)sql";
db_query(str);
return true; // IMPROVEME remove me in the future: this is only for a moment until we do migration on all our sites
}
bool ItemContent::do_migration_to_2()
{
const char * str = R"sql(
alter table core.content
add column user_id integer,
add column group_id integer,
add column guest_name character varying(20),
add column modification_user_id integer,
add column privileges integer,
add column date_creation timestamp without time zone,
add column date_modification timestamp without time zone,
add column link_to character varying(2048),
add column link_redirect smallint,
add column meta text,
add column meta_admin text,
add column content_parsed text,
add column content_parsed_type smallint;
)sql";
return db_query(str);
}
bool ItemContent::do_migration_to_3()
{
const char * str[] = {
"alter table core.content rename column ref to \"references\";",
"alter table core.content rename column content to content_raw;",
"alter table core.content rename column content_type to content_raw_type;",
"alter table core.content rename column has_thumb to file_has_thumb;",
"alter table core.content rename column hash to file_hash;",
"alter table core.content rename column hash_type to file_hash_type;",
"alter table core.content drop column modify_index;",
"alter table core.content add column file_has_thumb_new boolean;",
"update core.content as c1 set file_has_thumb_new = (select case when file_has_thumb <> 0 then true else false end from core.content as c2 where c1.id = c2.id);",
"alter table core.content drop column file_has_thumb;",
"alter table core.content rename file_has_thumb_new to file_has_thumb;",
};
size_t len = sizeof(str) / sizeof(const char*);
return db_query(str, len);
}
bool ItemContent::do_migration_to_4()
{
const char * str[] = {
"alter table core.content rename column meta_admin to admin_meta;",
};
size_t len = sizeof(str) / sizeof(const char*);
return db_query(str, len);
}
bool ItemContent::has_access(const User * current_user, int mask) const
{
if( current_user )
{
if( current_user->is_super_user )
{
// super user is allowed everything
return true;
}
if( user_id != -1 && current_user->id == user_id )
{
// the owner
return ((privileges >> 9) & mask) == mask;
}
if( group_id != -1 && current_user->IsMemberOf(group_id) )
{
// group
return ((privileges >> 6) & mask) == mask;
}
// others -- others logged users
return ((privileges >> 3) & mask) == mask;
}
// guests -- not logged users
return (privileges & mask) == mask;
}
bool ItemContent::has_read_access(const User * current_user) const
{
return has_access(current_user, 4); // r
}
bool ItemContent::has_write_access(const User * current_user) const
{
return has_access(current_user, 2); // w
}
bool ItemContent::has_read_write_access(const User * current_user) const
{
return has_access(current_user, 6); // r+w
}
bool ItemContent::has_read_exec_access(const User * current_user) const
{
if( current_user && current_user->is_super_user )
{
// there must be at least one 'x' (for the root)
// !! CHECK ME: is it applicable to directories too?
return (privileges & 01111) != 0;
}
return has_access(current_user, 5); // r+x
}
bool ItemContent::has_read_access() const
{
return has_read_access(get_current_user());
}
bool ItemContent::has_write_access() const
{
return has_write_access(get_current_user());
}
bool ItemContent::has_read_write_access() const
{
return has_read_write_access(get_current_user());
}
bool ItemContent::has_read_exec_access() const
{
return has_read_exec_access(get_current_user());
}
bool ItemContent::is_sticky_bit_set() const
{
int mask = 010000;
return (privileges & mask) == mask;
}
/*
* we're using the HtmlFilter only for those contents
*
*/
bool ItemContent::CanContentBeHtmlFiltered(ItemContent::ContentType ct)
{
return ct == ct_text || ct == ct_formatted_text || ct == ct_html || ct == ct_bbcode;
}
bool ItemContent::CanContentBeHtmlFiltered()
{
return CanContentBeHtmlFiltered(content_raw_type);
}
void ItemContent::print_content(HtmlTextStream & out, const pt::WTextStream & content, ItemContent::ContentType content_type, bool is_html_filter_on)
{
using TemplatesFunctions::R;
if( is_html_filter_on && !ItemContent::CanContentBeHtmlFiltered(content_type) )
out << R("<nofilter>");
if( content_type == ItemContent::ct_text )
{
out << content;
}
else
if( content_type == ItemContent::ct_formatted_text )
{
std::wstring tmp_string;
content.to_str(tmp_string);
TemplatesFunctions::HtmlEscapeFormTxt(out, tmp_string);
}
else
if( content_type == ItemContent::ct_bbcode )
{
static std::wstring out_temp;
out_temp.clear();
out_temp.reserve(content.size()*2);
BBCODEParser bbcode_parser; // IMPROVE ME move me to a better place
std::wstring tmp_string;
content.to_str(tmp_string);
bbcode_parser.Filter(tmp_string.c_str(), out_temp);
out << R(out_temp);
}
else
{
// ct_html, ct_other
out.get_buffer().operator<<(content); // tricky way of putting content without escaping
}
if( is_html_filter_on && !ItemContent::CanContentBeHtmlFiltered(content_type) )
out << R("</nofilter>");
}
void ItemContent::print_content(HtmlTextStream & out, const std::wstring & content, ItemContent::ContentType content_type, bool is_html_filter_on)
{
using TemplatesFunctions::R;
if( is_html_filter_on && !ItemContent::CanContentBeHtmlFiltered(content_type) )
out << R("<nofilter>");
if( content_type == ItemContent::ct_text )
{
out << content;
}
else
if( content_type == ItemContent::ct_formatted_text )
{
TemplatesFunctions::HtmlEscapeFormTxt(out, content);
}
else
if( content_type == ItemContent::ct_bbcode )
{
static std::wstring out_temp;
out_temp.clear();
out_temp.reserve(content.size()*2);
BBCODEParser bbcode_parser; // IMPROVE ME move me to a better place
bbcode_parser.Filter(content.c_str(), out_temp);
out << R(out_temp);
}
else
{
// ct_html, ct_other
out << R(content);
}
if( is_html_filter_on && !ItemContent::CanContentBeHtmlFiltered(content_type) )
out << R("</nofilter>");
}
void ItemContent::print_content(EzcEnv & env)
{
print_content(env.out, content_raw, content_raw_type, true); // IMPROVE ME get the 'true' from the config (config->html_filter)
}
void ItemContent::has_static_file(EzcEnv & env)
{
env.res = file_type != WINIX_ITEM_FILETYPE_NONE && !file_path.empty();
}
void ItemContent::privileges_octal(EzcEnv & env)
{
env.out << Toa(privileges, 8);
}
bool ItemContent::has_user() const
{
return user_id != -1;
}
bool ItemContent::has_group() const
{
return group_id != -1;
}
bool ItemContent::item_users_different()
{
return user_id != modification_user_id;
}
void ItemContent::user(morm::Wrapper & wrapper)
{
Users * users = get_users();
if( users )
{
User * puser = users->GetUser(user_id);
if( puser )
{
wrapper.model = puser;
}
}
}
void ItemContent::group(morm::Wrapper & wrapper)
{
Groups * groups = get_groups();
if( groups )
{
Group * pgroup = groups->GetGroup(group_id);
if( pgroup )
{
wrapper.model = pgroup;
}
}
}
bool ItemContent::content_type_is(const std::wstring & type)
{
if( content_raw_type == ItemContent::ct_text && type == L"text" )
return true;
else
if( content_raw_type == ItemContent::ct_formatted_text && type == L"formatted text" )
return true;
else
if( content_raw_type == ItemContent::ct_html && type == L"html" )
return true;
else
if( content_raw_type == ItemContent::ct_bbcode && type == L"bbcode" )
return true;
else
if( content_raw_type == ItemContent::ct_other && type == L"other" )
return true;
return false;
}
void ItemContent::type_is(EzcEnv & env)
{
env.res = content_type_is(env.par);
}
void ItemContent::is_empty(EzcEnv & env)
{
env.res = content_raw.empty();
}
void ItemContent::file_type_is_none(EzcEnv & env)
{
env.res = file_type == WINIX_ITEM_FILETYPE_NONE;
}
/*
* when we change file_type to string the we can return true only for
* those images which can be able to show by a webbrowser
*
*/
void ItemContent::file_type_is_image(EzcEnv & env)
{
env.res = file_type == WINIX_ITEM_FILETYPE_IMAGE;
}
/*
* similar we can return true only for those videos which can be rendered by a webbrowser
*/
void ItemContent::file_type_is_video(EzcEnv & env)
{
env.res = file_type == WINIX_ITEM_FILETYPE_VIDEO;
}
void ItemContent::file_type_is_sound(EzcEnv & env)
{
//env.res = file_type == WINIX_ITEM_FILETYPE_;
env.res = false;
}
void ItemContent::has_thumb(EzcEnv & env)
{
env.res = file_has_thumb;
}
void ItemContent::display_user_name(EzcEnv & env)
{
Locale * locale = get_locale();
if( user_id != -1 )
{
Users * users = get_users();
if( users )
{
User * user = users->GetUser(user_id);
if( user )
{
user->display_name(env);
}
else
{
if( locale )
locale->Get(L"not_existing_user");
else
env.out << "not existing user";
}
}
}
else
{
// IMPROVEME these should be moved to a better place
env.out << "~";
if( !guest_name.empty() && !IsWhite(guest_name) )
{
env.out << guest_name;
}
else
{
if( locale )
env.out << locale->Get(L"display_guest_name");
else
env.out << "guest";
}
}
}
bool ItemContent::is_meta_object() const
{
return meta.is_object();
}
bool ItemContent::is_admin_meta_object() const
{
return admin_meta.is_object();
}
bool ItemContent::are_dates_equal() const
{
return date_creation == date_modification;
}
bool ItemContent::is_link_to() const
{
return !link_to.empty();
}
bool ItemContent::is_link_redirect() const
{
return link_redirect == 1;
}
} // namespace Winix