HTML.pm 19 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584
  1. package Trog::Routes::HTML;
  2. use strict;
  3. use warnings;
  4. no warnings 'experimental';
  5. use feature qw{signatures state};
  6. use File::Touch();
  7. use Trog::Config;
  8. use Trog::Data;
  9. my $conf = Trog::Config::get();
  10. my $template_dir = 'www/templates';
  11. my $theme_dir;
  12. $theme_dir = "themes/".$conf->param('general.theme') if $conf->param('general.theme') && -d "www/themes/".$conf->param('general.theme');
  13. use lib 'www';
  14. our $landing_page = 'default.tx';
  15. our $htmltitle = 'title.tx';
  16. our $midtitle = 'midtitle.tx';
  17. our $rightbar = 'rightbar.tx';
  18. our $leftbar = 'leftbar.tx';
  19. our $footbar = 'footbar.tx';
  20. our %routes = (
  21. default => {
  22. callback => \&Trog::Routes::HTML::setup,
  23. },
  24. '/' => {
  25. method => 'GET',
  26. callback => \&Trog::Routes::HTML::index,
  27. },
  28. # This should only be enabled to debug
  29. # '/setup' => {
  30. # method => 'GET',
  31. # callback => \&Trog::Routes::HTML::setup,
  32. # },
  33. '/login' => {
  34. method => 'GET',
  35. callback => \&Trog::Routes::HTML::login,
  36. },
  37. '/auth' => {
  38. method => 'POST',
  39. nostatic => 1,
  40. callback => \&Trog::Routes::HTML::login,
  41. },
  42. '/config' => {
  43. method => 'GET',
  44. auth => 1,
  45. callback => \&Trog::Routes::HTML::config,
  46. },
  47. '/config/save' => {
  48. method => 'POST',
  49. auth => 1,
  50. callback => \&Trog::Routes::HTML::config_save,
  51. },
  52. '/post' => {
  53. method => 'GET',
  54. auth => 1,
  55. callback => \&Trog::Routes::HTML::post,
  56. },
  57. '/post/save' => {
  58. method => 'POST',
  59. auth => 1,
  60. callback => \&Trog::Routes::HTML::post,
  61. },
  62. '/post/(.*)' => {
  63. method => 'GET',
  64. auth => 1,
  65. callback => \&Trog::Routes::HTML::post,
  66. captures => ['id'],
  67. },
  68. '/posts/(.*)' => {
  69. method => 'GET',
  70. callback => \&Trog::Routes::HTML::posts,
  71. captures => ['id'],
  72. },
  73. '/posts' => {
  74. method => 'GET',
  75. callback => \&Trog::Routes::HTML::posts,
  76. },
  77. '/profile' => {
  78. method => 'POST',
  79. auth => 1,
  80. callback => \&Trog::Routes::HTML::profile,
  81. },
  82. '/themeclone' => {
  83. method => 'POST',
  84. auth => 1,
  85. callback => \&Trog::Routes::HTML::themeclone,
  86. },
  87. '/sitemap', => {
  88. method => 'GET',
  89. callback => \&Trog::Routes::HTML::sitemap,
  90. },
  91. );
  92. # Build aliases for /posts and /post with extra data
  93. my @post_aliases = qw{news blog image video audio about files series};
  94. @routes{map { "/$_" } @post_aliases} = map { my %copy = %{$routes{'/posts'}}; $copy{data}{tag} = [$_]; \%copy } @post_aliases;
  95. #TODO clean this up so we don't need _build_post_type
  96. @routes{map { "/post/$_" } qw{image video audio files}} = map { my %copy = %{$routes{'/post'}}; $copy{data}{tag} = [$_]; $copy{data}{type} = 'file'; \%copy } qw{image video audio files};
  97. $routes{'/post/news'} = { method => 'GET', auth => 1, callback => \&Trog::Routes::HTML::post, data => { tag => ['news'], type => 'microblog' } };
  98. $routes{'/post/blog'} = { method => 'GET', auth => 1, callback => \&Trog::Routes::HTML::post, data => { tag => ['blog'], type => 'blog' } };
  99. $routes{'/post/about'} = { method => 'GET', auth => 1, callback => \&Trog::Routes::HTML::post, data => { tag => ['profile'], type => 'profile' } };
  100. $routes{'/post/series'} = { method => 'GET', auth => 1, callback => \&Trog::Routes::HTML::post, data => { tag => ['series'], type => 'series' } };
  101. # Build aliases for /posts/(.*) and /post/(.*) with extra data
  102. @routes{map { "/$_/(.*)" } @post_aliases} = map { my %copy = %{$routes{'/posts/(.*)'}}; \%copy } @post_aliases;
  103. @routes{map { "/$_/(.*)" } @post_aliases} = map { my %copy = %{$routes{'/post/(.*)'}}; \%copy } @post_aliases;
  104. # Grab theme routes
  105. my $themed = 0;
  106. if ($theme_dir) {
  107. my $theme_mod = "$theme_dir/routes.pm";
  108. if (-f "www/$theme_mod" ) {
  109. require $theme_mod;
  110. @routes{keys(%Theme::routes)} = values(%Theme::routes);
  111. $themed = 1;
  112. }
  113. }
  114. # TODO build a sitemap.xml based on the above routing table, and robots.txt
  115. sub index ($query, $input, $render_cb, $content = '', $i_styles = []) {
  116. $query->{theme_dir} = $theme_dir || '';
  117. my $processor = Text::Xslate->new(
  118. path => $template_dir,
  119. );
  120. my $t_processor;
  121. $t_processor = Text::Xslate->new(
  122. path => "www/$theme_dir/templates",
  123. ) if $theme_dir;
  124. $content ||= _pick_processor($rightbar,$processor,$t_processor)->render($landing_page,$query);
  125. my @styles = ('/styles/avatars.css'); #TODO generate file for users
  126. if ($theme_dir) {
  127. unshift(@styles, _themed_style("screen.css")) if -f 'www/'._themed_style("screen.css");
  128. unshift(@styles, _themed_style("structure.css")) if -f 'www/'._themed_style("structure.css");
  129. }
  130. push( @styles, @$i_styles);
  131. #TODO allow theming of print css
  132. my $search_info = Trog::Data->new($conf);
  133. return $render_cb->('index.tx',{
  134. code => $query->{code},
  135. user => $query->{user},
  136. search_lang => $search_info->{lang},
  137. search_help => $search_info->{help},
  138. route => $query->{route},
  139. theme_dir => $theme_dir,
  140. content => $content,
  141. title => $conf->param('general.title'), #TODO control in theme instead
  142. htmltitle => _pick_processor("templates/$htmltitle" ,$processor,$t_processor)->render($htmltitle,$query),
  143. midtitle => _pick_processor("templates/$midtitle" ,$processor,$t_processor)->render($midtitle,$query),
  144. rightbar => _pick_processor("templates/$rightbar" ,$processor,$t_processor)->render($rightbar,$query),
  145. leftbar => _pick_processor("templates/$leftbar" ,$processor,$t_processor)->render($leftbar,$query),
  146. footbar => _pick_processor("templates/$footbar" ,$processor,$t_processor)->render($footbar,$query),
  147. stylesheets => \@styles,
  148. });
  149. }
  150. =head1 ADMIN ROUTES
  151. These are things that issue returns other than 200, and are not directly accessible by users via any defined route.
  152. =head2 notfound, forbidden, badrequest
  153. Implements the 4XX status codes. Override templates named the same for theming this.
  154. =cut
  155. sub _generic_route ($rname, $code, $title, $query,$input,$render_cb) {
  156. $query->{code} = $code;
  157. my $processor = Text::Xslate->new(
  158. path => _dir_for_resource("$rname.tx"),
  159. );
  160. my $styles = _build_themed_styles("$rname.css");
  161. my $content = $processor->render("$rname.tx", {
  162. title => $title,
  163. route => $query->{route},
  164. user => $query->{user},
  165. styles => $styles,
  166. });
  167. return Trog::Routes::HTML::index($query, $input, $render_cb, $content, $styles);
  168. }
  169. sub notfound (@args) {
  170. return _generic_route('notfound',404,"Return to sender, Address unknown", @args);
  171. }
  172. sub forbidden (@args) {
  173. return _generic_route('forbidden', 403, "STAY OUT YOU RED MENACE", @args);
  174. }
  175. sub badrequest (@args) {
  176. return _generic_route('badrequest', 400, "Bad Request", @args);
  177. }
  178. # TODO Rate limiting route
  179. =head1 NORMAL ROUTES
  180. These are expected to either return a 200, or redirect to something which does.
  181. =head2 setup
  182. One time setup page; should only display to the first user to visit the site which we presume to be the administrator.
  183. =cut
  184. sub setup ($query, $input, $render_cb) {
  185. File::Touch::touch("$ENV{HOME}/.tcms/setup");
  186. return $render_cb->('notconfigured.tx', {
  187. title => 'tCMS Requires Setup to Continue...',
  188. stylesheets => _build_themed_styles('notconfigured.css'),
  189. });
  190. }
  191. =head2 login
  192. Sets the user cookie if the provided user exists, or sets up the user as an admin with the provided credentials in the event that no users exist.
  193. =cut
  194. sub login ($query, $input, $render_cb) {
  195. # Redirect if we actually have a logged in user.
  196. # Note to future me -- this user value is overwritten explicitly in server.psgi.
  197. # If that ever changes, you will die
  198. $query->{to} //= '/config';
  199. if ($query->{user}) {
  200. return $routes{$query->{to}}{callback}->($query,$input,$render_cb);
  201. }
  202. #Set the cookiez and issue a 302 back to ourselves if we have good creds
  203. my $postdata = _input2postdata($input);
  204. #Check and see if we have no users. If so we will just accept whatever creds are passed.
  205. my $hasusers = -f "$ENV{HOME}/.tcms/has_users";
  206. my $btnmsg = $hasusers ? "Log In" : "Register";
  207. my @headers;
  208. if ($postdata->{username} && $postdata->{password}) {
  209. if (!$hasusers) {
  210. # Make the first user
  211. Trog::Auth::useradd($postdata->{username}, $postdata->{password}, ['admin'] );
  212. File::Touch::touch("$ENV{HOME}/.tcms/has_users");
  213. }
  214. $query->{failed} = 1;
  215. my $cookie = Trog::Auth::mksession($postdata->{username}, $postdata->{password});
  216. if ($cookie) {
  217. # TODO secure / sameSite cookie to kill csrf, maybe do rememberme with Expires=~0
  218. @headers = (
  219. "Set-Cookie: tcmslogin=$cookie; HttpOnly",
  220. );
  221. $query->{failed} = 0;
  222. }
  223. }
  224. $query->{failed} //= -1;
  225. return $render_cb->('login.tx', {
  226. title => 'tCMS 2 ~ Login',
  227. to => $query->{to},
  228. failure => int( $query->{failed} ),
  229. message => int( $query->{failed} ) < 1 ? "Login Successful, Redirecting..." : "Login Failed.",
  230. btnmsg => $btnmsg,
  231. stylesheets => _build_themed_styles('login.css'),
  232. }, @headers);
  233. }
  234. =head2 config
  235. Renders the configuration page, or redirects you back to the login page.
  236. =cut
  237. sub config ($query, $input, $render_cb) {
  238. if (!$query->{user}) {
  239. $query->{to} = '/config';
  240. return login($query,$input,$render_cb);
  241. }
  242. #NOTE: we are relying on this to skip the ACL check with 'admin', this may not be viable in future?
  243. return forbidden($query, $input, $render_cb) unless grep { $_ eq 'admin' } @{$query->{acls}};
  244. my $css = _build_themed_styles('config.css');
  245. my $js = _build_themed_scripts('post.js');
  246. $query->{failure} //= -1;
  247. return $render_cb->('config.tx', {
  248. title => 'Configure tCMS',
  249. stylesheets => $css,
  250. scripts => $js,
  251. themes => _get_themes(),
  252. data_models => _get_data_models(),
  253. current_theme => $conf->param('general.theme') // '',
  254. current_data_model => $conf->param('general.data_model') // 'DUMMY',
  255. message => $query->{message},
  256. failure => $query->{failure},
  257. to => '/config',
  258. });
  259. }
  260. sub _get_themes {
  261. my $dir = 'www/themes';
  262. opendir(my $dh, $dir) || die "Can't opendir $dir: $!";
  263. my @tdirs = grep { !/^\./ && -d "$dir/$_" } readdir($dh);
  264. closedir $dh;
  265. return \@tdirs;
  266. }
  267. sub _get_data_models {
  268. my $dir = 'lib/Trog/Data';
  269. opendir(my $dh, $dir) || die "Can't opendir $dir: $!";
  270. my @dmods = map { s/\.pm$//g; $_ } grep { /\.pm$/ && -f "$dir/$_" } readdir($dh);
  271. closedir $dh;
  272. return \@dmods
  273. }
  274. =head2 config_save
  275. Implements /config/save route. Saves what little configuration we actually use to ~/.tcms/tcms.conf
  276. =cut
  277. sub config_save ($query, $input, $render_cb) {
  278. my $postdata = _input2postdata($input);
  279. $conf->param( 'general.theme', $postdata->{theme} ) if defined $postdata->{theme};
  280. $conf->param( 'general.data_model', $postdata->{data_model} ) if $postdata->{data_model};
  281. $query->{failure} = 1;
  282. $query->{message} = "Failed to save configuration!";
  283. if ($conf->save($Trog::Config::home_config)) {
  284. $query->{failure} = 0;
  285. $query->{message} = "Configuration updated succesfully.";
  286. }
  287. # TODO we need to soft-restart the server at this point. Maybe we can just hot-load config on each page when we get to have static renders? Probably not worth the perf hit for paywall users.
  288. return config($query, $input, $render_cb);
  289. }
  290. # TODO actually do stuff
  291. sub profile ($query, $input, $render_cb) {
  292. return config($query, $input, $render_cb);
  293. }
  294. =head2 themeclone
  295. Clone a theme by copying a directory.
  296. =cut
  297. sub themeclone ($query, $input, $render_cb) {
  298. my $postdata = _input2postdata($input);
  299. my ($theme, $newtheme) = ($postdata->{theme},$postdata->{newtheme});
  300. my $themedir = 'www/themes';
  301. $query->{failure} = 1;
  302. $query->{message} = "Failed to clone theme '$theme' as '$newtheme'!";
  303. require File::Copy::Recursive;
  304. if ($theme && $newtheme && File::Copy::Recursive::dircopy( "$themedir/$theme", "$themedir/$newtheme" )) {
  305. $query->{failure} = 0;
  306. $query->{message} = "Successfully cloned theme '$theme' as '$newtheme'.";
  307. }
  308. return config($query, $input, $render_cb);
  309. }
  310. =head2 post
  311. Display the route for making new posts.
  312. =cut
  313. sub post ($query, $input, $render_cb) {
  314. if (!$query->{user}) {
  315. $query->{to} = '/post';
  316. return login($query,$input,$render_cb);
  317. }
  318. return forbidden($query, $input, $render_cb) unless grep { $_ eq 'admin' } @{$query->{acls}};
  319. my $tags = _coerce_array($query->{tag});
  320. my $posts = _post_helper($query, $tags, $query->{acls});
  321. my $css = _build_themed_styles('post.css');
  322. my $js = _build_themed_scripts('post.js');
  323. push(@$css, '/styles/avatars.css');
  324. return $render_cb->('post.tx', {
  325. title => 'New Post',
  326. post_visibilities => ['public', 'private', 'unlisted'],
  327. stylesheets => $css,
  328. scripts => $js,
  329. posts => $posts,
  330. can_edit => 1,
  331. types => [qw{microblog blog file series profile}],
  332. route => '/posts',
  333. category => '/posts',
  334. page => int($query->{page} || 1),
  335. limit => int($query->{limit} || 1),
  336. sizes => [25,50,100],
  337. id => $query->{id},
  338. acls => _post_helper({}, ['series'], $query->{acls}),
  339. edittype => $query->{type} || 'microblog',
  340. });
  341. }
  342. #TODO actually do stuff
  343. sub post_save ($query, $input, $render_cb) {
  344. return post($query, $input, $render_cb);
  345. }
  346. =head2 posts
  347. Display multi or single posts, supports RSS and pagination.
  348. =cut
  349. sub posts ($query, $input, $render_cb) {
  350. my $tags = _coerce_array($query->{tag});
  351. #TODO If we have a direct ID query, we should show unlisted videos as well as public ones IFF they have a valid campaign ID attached to query
  352. push(@{$query->{acls}}, 'public');
  353. my $posts = _post_helper($query, $tags, $query->{acls});
  354. return notfound($query,$input,$render_cb) unless @$posts;
  355. my $fmt = $query->{format} || '';
  356. return _rss($posts) if $fmt eq 'rss';
  357. my $processor = Text::Xslate->new(
  358. path => _dir_for_resource('posts.tx'),
  359. );
  360. my $styles = _build_themed_styles('posts.css');
  361. my $content = $processor->render('posts.tx', {
  362. title => "Posts tagged @$tags",
  363. posts => $posts,
  364. route => $query->{route},
  365. page => int($query->{page} || 1),
  366. limit => int($query->{limit} || 1),
  367. sizes => [25,50,100],
  368. rss => !$query->{id},
  369. tiled => scalar(grep { $_ eq $query->{route} } qw{/files /audio /video /image /series}),
  370. category => $themed ? Theme::path_to_tile($query->{route}) : $query->{route},
  371. });
  372. return Trog::Routes::HTML::index($query, $input, $render_cb, $content, $styles);
  373. }
  374. sub _post_helper ($query, $tags, $acls) {
  375. state $data = Trog::Data->new($conf);
  376. return $data->get(
  377. page => int($query->{page} || 1),
  378. limit => int($query->{limit} || 25),
  379. tags => $tags,
  380. acls => $acls,
  381. like => $query->{like},
  382. id => $query->{id},
  383. );
  384. }
  385. =head2 sitemap
  386. Return the sitemap index unless the static or a set of dynamic routes is requested.
  387. We have a maximum of 99,990,000 posts we can make under this model
  388. As we have 10,000 * 10,000 posts which are indexable via the sitemap format.
  389. 1 top level index slot (10k posts) is taken by our static routes, the rest will be /posts.
  390. =cut
  391. sub sitemap ($query, $input, $render_cb) {
  392. my (@to_map, $is_index, $route_type);
  393. my $warning = '';
  394. $query->{map} //= '';
  395. if ($query->{map} eq 'static') {
  396. # Return the map of static routes
  397. $route_type = 'Static Routes';
  398. @to_map = grep { !defined $routes{$_}->{captures} && $_ ne 'default' } keys(%routes);
  399. } elsif ( !$query->{map} ) {
  400. # Return the index instead
  401. @to_map = ('static');
  402. my $data = Trog::Data->new($conf);
  403. my $tot = $data->total_posts();
  404. my $size = 50000;
  405. my $pages = int($tot / $size) + (($tot % $size) ? 1 : 0);
  406. # Truncate pages at 10k due to standard
  407. my $clamped = $pages > 49999 ? 49999 : $pages;
  408. $warning = "More posts than possible to represent in sitemaps & index! Old posts have been truncated." if $pages > 49999;
  409. foreach my $page ($clamped..1) {
  410. push(@to_map, "$page");
  411. }
  412. $is_index = 1;
  413. } else {
  414. $route_type = "Posts: Page $query->{map}";
  415. # Return the map of the particular range of dynamic posts
  416. $query->{limit} = 50000;
  417. $query->{page} = $query->{map};
  418. @to_map = @{_post_helper($query, {}, ['public'])};
  419. }
  420. @to_map = sort @to_map unless $is_index;
  421. my $processor = Text::Xslate->new(
  422. path => _dir_for_resource('sitemap.tx'),
  423. );
  424. my $styles = _build_themed_styles('sitemap.css');
  425. my $content = $processor->render('sitemap.tx', {
  426. title => "Site Map",
  427. to_map => \@to_map,
  428. is_index => $is_index,
  429. route_type => $route_type,
  430. route => $query->{route},
  431. });
  432. return Trog::Routes::HTML::index($query,$input,$render_cb,$content,$styles);
  433. }
  434. sub _rss ($posts) {
  435. return [200, ["Content-type: text/plain\n"], ["TODO"]];
  436. }
  437. sub _input2postdata ($input) {
  438. #Set the cookiez and issue a 302 back to ourselves if we have good creds
  439. my ($slurpee,$postdata) = ('',{});
  440. while (<$input>) { $slurpee .= $_ }
  441. $postdata = URL::Encode::url_params_mixed($slurpee) if $slurpee;
  442. return $postdata;
  443. }
  444. # Deal with Params which may or may not be arrays
  445. sub _coerce_array ($param) {
  446. my $p = $param || [];
  447. $p = [$param] if $param && (ref $param ne 'ARRAY');
  448. return $p;
  449. }
  450. sub _build_themed_styles ($style) {
  451. my @styles = ("/styles/$style");
  452. my $ts = _themed_style($style);
  453. push(@styles, $ts) if $theme_dir && -f "www/$ts";
  454. return \@styles;
  455. }
  456. sub _build_themed_scripts ($script) {
  457. my @scripts = ("/scripts/$script");
  458. my $ts = _themed_style($script);
  459. push(@scripts, $ts) if $theme_dir && -f "www/$ts";
  460. return \@scripts;
  461. }
  462. sub _pick_processor($file, $normal, $themed) {
  463. return _dir_for_resource($file) eq $template_dir ? $normal : $themed;
  464. }
  465. # Pick appropriate dir based on whether theme override exists
  466. sub _dir_for_resource ($resource) {
  467. return $theme_dir && -f "www/$theme_dir/$resource" ? $theme_dir : $template_dir;
  468. }
  469. sub _themed_style ($resource) {
  470. return _dir_for_resource("styles/$resource")."/styles/$resource";
  471. }
  472. sub _themed_script ($resource) {
  473. return _dir_for_resource("scripts/$resource")."/scripts/$resource";
  474. }
  475. 1;