HTML.pm 18 KB

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