PageEditorByHackmd.jsx 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430
  1. import React from 'react';
  2. import PropTypes from 'prop-types';
  3. import loggerFactory from '@alias/logger';
  4. import { withTranslation } from 'react-i18next';
  5. import AppContainer from '../services/AppContainer';
  6. import PageContainer from '../services/PageContainer';
  7. import EditorContainer from '../services/EditorContainer';
  8. import { withUnstatedContainers } from './UnstatedUtils';
  9. import HackmdEditor from './PageEditorByHackmd/HackmdEditor';
  10. const logger = loggerFactory('growi:PageEditorByHackmd');
  11. class PageEditorByHackmd extends React.Component {
  12. constructor(props) {
  13. super(props);
  14. this.state = {
  15. isInitialized: false,
  16. isInitializing: false,
  17. // for error
  18. hasError: false,
  19. errorMessage: '',
  20. errorReason: '',
  21. };
  22. this.getHackmdUri = this.getHackmdUri.bind(this);
  23. this.startToEdit = this.startToEdit.bind(this);
  24. this.resumeToEdit = this.resumeToEdit.bind(this);
  25. this.onSaveWithShortcut = this.onSaveWithShortcut.bind(this);
  26. this.hackmdEditorChangeHandler = this.hackmdEditorChangeHandler.bind(this);
  27. this.penpalErrorOccuredHandler = this.penpalErrorOccuredHandler.bind(this);
  28. }
  29. componentWillMount() {
  30. this.props.appContainer.registerComponentInstance('PageEditorByHackmd', this);
  31. }
  32. /**
  33. * return markdown document of HackMD
  34. * @return {Promise<string>}
  35. */
  36. getMarkdown() {
  37. const { t } = this.props;
  38. if (!this.state.isInitialized) {
  39. return Promise.reject(new Error(t('hackmd.not_initialized')));
  40. }
  41. return this.hackmdEditor.getValue();
  42. }
  43. /**
  44. * reset initialized status
  45. */
  46. reset() {
  47. this.setState({ isInitialized: false });
  48. }
  49. getHackmdUri() {
  50. const envVars = this.props.appContainer.getConfig().env;
  51. return envVars.HACKMD_URI;
  52. }
  53. get isResume() {
  54. const { pageContainer } = this.props;
  55. const {
  56. pageIdOnHackmd, hasDraftOnHackmd, isHackmdDraftUpdatingInRealtime,
  57. } = pageContainer.state;
  58. const isPageExistsOnHackmd = (pageIdOnHackmd != null);
  59. return (isPageExistsOnHackmd && hasDraftOnHackmd) || isHackmdDraftUpdatingInRealtime;
  60. }
  61. /**
  62. * Start integration with HackMD
  63. */
  64. async startToEdit() {
  65. const { pageContainer } = this.props;
  66. const hackmdUri = this.getHackmdUri();
  67. if (hackmdUri == null) {
  68. // do nothing
  69. return;
  70. }
  71. this.setState({
  72. isInitialized: false,
  73. isInitializing: true,
  74. });
  75. const params = {
  76. pageId: pageContainer.state.pageId,
  77. };
  78. try {
  79. const res = await this.props.appContainer.apiPost('/hackmd.integrate', params);
  80. if (!res.ok) {
  81. throw new Error(res.error);
  82. }
  83. await pageContainer.setState({
  84. pageIdOnHackmd: res.pageIdOnHackmd,
  85. revisionIdHackmdSynced: res.revisionIdHackmdSynced,
  86. });
  87. }
  88. catch (err) {
  89. pageContainer.showErrorToastr(err);
  90. this.setState({
  91. hasError: true,
  92. errorMessage: 'GROWI server failed to connect to HackMD.',
  93. errorReason: err.toString(),
  94. });
  95. }
  96. this.setState({
  97. isInitialized: true,
  98. isInitializing: false,
  99. });
  100. }
  101. /**
  102. * Start to edit w/o any api request
  103. */
  104. resumeToEdit() {
  105. this.setState({ isInitialized: true });
  106. }
  107. /**
  108. * Reset draft
  109. */
  110. async discardChanges() {
  111. const { pageContainer } = this.props;
  112. const { pageId } = pageContainer.state;
  113. try {
  114. const res = await this.props.appContainer.apiPost('/hackmd.discard', { pageId });
  115. if (!res.ok) {
  116. throw new Error(res.error);
  117. }
  118. this.props.pageContainer.setState({
  119. isHackmdDraftUpdatingInRealtime: false,
  120. hasDraftOnHackmd: false,
  121. pageIdOnHackmd: res.pageIdOnHackmd,
  122. remoteRevisionId: res.revisionIdHackmdSynced,
  123. revisionIdHackmdSynced: res.revisionIdHackmdSynced,
  124. });
  125. }
  126. catch (err) {
  127. logger.error(err);
  128. pageContainer.showErrorToastr(err);
  129. }
  130. }
  131. /**
  132. * save and update state of containers
  133. * @param {string} markdown
  134. */
  135. async onSaveWithShortcut(markdown) {
  136. const { pageContainer, editorContainer } = this.props;
  137. const optionsToSave = editorContainer.getCurrentOptionsToSave();
  138. try {
  139. // disable unsaved warning
  140. editorContainer.disableUnsavedWarning();
  141. // eslint-disable-next-line no-unused-vars
  142. const { page, tags } = await pageContainer.save(markdown, optionsToSave);
  143. logger.debug('success to save');
  144. pageContainer.showSuccessToastr();
  145. // update state of EditorContainer
  146. editorContainer.setState({ tags });
  147. }
  148. catch (error) {
  149. logger.error('failed to save', error);
  150. pageContainer.showErrorToastr(error);
  151. }
  152. }
  153. /**
  154. * onChange event of HackmdEditor handler
  155. */
  156. async hackmdEditorChangeHandler(body) {
  157. const hackmdUri = this.getHackmdUri();
  158. const { pageContainer, editorContainer } = this.props;
  159. if (hackmdUri == null) {
  160. // do nothing
  161. return;
  162. }
  163. // do nothing if contents are same
  164. if (pageContainer.state.markdown === body) {
  165. return;
  166. }
  167. // enable unsaved warning
  168. editorContainer.enableUnsavedWarning();
  169. const params = {
  170. pageId: pageContainer.state.pageId,
  171. };
  172. try {
  173. await this.props.appContainer.apiPost('/hackmd.saveOnHackmd', params);
  174. }
  175. catch (err) {
  176. logger.error(err);
  177. }
  178. }
  179. penpalErrorOccuredHandler(error) {
  180. const { pageContainer, t } = this.props;
  181. pageContainer.showErrorToastr(error);
  182. this.setState({
  183. hasError: true,
  184. errorMessage: t('hackmd.fail_to_connect'),
  185. errorReason: error.toString(),
  186. });
  187. }
  188. renderPreInitContent() {
  189. const hackmdUri = this.getHackmdUri();
  190. const { pageContainer, t } = this.props;
  191. const {
  192. revisionId, revisionIdHackmdSynced, remoteRevisionId, pageId,
  193. } = pageContainer.state;
  194. const isPageNotFound = pageId == null;
  195. let content;
  196. /*
  197. * HackMD is not setup
  198. */
  199. if (hackmdUri == null) {
  200. content = (
  201. <div>
  202. <p className="text-center hackmd-status-label"><i className="fa fa-file-text"></i> { t('hackmd.not_set_up')}</p>
  203. {/* eslint-disable-next-line react/no-danger */}
  204. <p dangerouslySetInnerHTML={{ __html: t('hackmd.need_to_associate_with_growi_to_use_hackmd_refer_to_this') }} />
  205. </div>
  206. );
  207. }
  208. /*
  209. * used HackMD from NotFound Page
  210. */
  211. else if (isPageNotFound) {
  212. content = (
  213. <div className="text-center">
  214. <p className="hackmd-status-label">
  215. <i className="fa fa-file-text mr-2" />
  216. { t('hackmd.used_for_not_found') }
  217. </p>
  218. {/* eslint-disable-next-line react/no-danger */}
  219. <p dangerouslySetInnerHTML={{ __html: t('hackmd.need_to_make_page') }} />
  220. </div>
  221. );
  222. }
  223. /*
  224. * Resume to edit or discard changes
  225. */
  226. else if (this.isResume) {
  227. const isHackmdDocumentOutdated = revisionIdHackmdSynced !== remoteRevisionId;
  228. content = (
  229. <div>
  230. <p className="text-center hackmd-status-label"><i className="fa fa-file-text"></i> HackMD is READY!</p>
  231. <p className="text-center"><strong>{t('hackmd.unsaved_draft')}</strong></p>
  232. { isHackmdDocumentOutdated && (
  233. <div className="card border-warning">
  234. <div className="card-header bg-warning"><i className="icon-fw icon-info"></i> {t('hackmd.draft_outdated')}</div>
  235. <div className="card-body text-center">
  236. {t('hackmd.based_on_revision')}&nbsp;
  237. <a href={`?revision=${revisionIdHackmdSynced}`}><span className="badge badge-secondary">{revisionIdHackmdSynced.substr(-8)}</span></a>
  238. <div className="text-center mt-3">
  239. <button
  240. className="btn btn-link btn-view-outdated-draft p-0"
  241. type="button"
  242. disabled={this.state.isInitializing}
  243. onClick={() => { return this.resumeToEdit() }}
  244. >
  245. {t('hackmd.view_outdated_draft')}
  246. </button>
  247. </div>
  248. </div>
  249. </div>
  250. ) }
  251. { !isHackmdDocumentOutdated && (
  252. <div className="text-center hackmd-resume-button-container mb-3">
  253. <button
  254. className="btn btn-success btn-lg waves-effect waves-light"
  255. type="button"
  256. disabled={this.state.isInitializing}
  257. onClick={() => { return this.resumeToEdit() }}
  258. >
  259. <span className="btn-label"><i className="icon-fw icon-control-end"></i></span>
  260. <span className="btn-text">{t('hackmd.resume_to_edit')}</span>
  261. </button>
  262. </div>
  263. ) }
  264. <div className="text-center hackmd-discard-button-container mb-3">
  265. <button
  266. className="btn btn-outline-secondary btn-lg waves-effect waves-light"
  267. type="button"
  268. onClick={() => { return this.discardChanges() }}
  269. >
  270. <span className="btn-label"><i className="icon-fw icon-control-start"></i></span>
  271. <span className="btn-text">{t('hackmd.discard_changes')}</span>
  272. </button>
  273. </div>
  274. </div>
  275. );
  276. }
  277. /*
  278. * Start to edit
  279. */
  280. else {
  281. const isRevisionOutdated = revisionId !== remoteRevisionId;
  282. content = (
  283. <div>
  284. <p className="text-muted text-center hackmd-status-label"><i className="fa fa-file-text"></i> HackMD is READY!</p>
  285. <div className="text-center hackmd-start-button-container mb-3">
  286. <button
  287. className="btn btn-info btn-lg waves-effect waves-light"
  288. type="button"
  289. disabled={isRevisionOutdated || this.state.isInitializing}
  290. onClick={() => { return this.startToEdit() }}
  291. >
  292. <span className="btn-label"><i className="icon-fw icon-paper-plane"></i></span>
  293. {t('hackmd.start_to_edit')}
  294. </button>
  295. </div>
  296. <p className="text-center">{t('hackmd.clone_page_content')}</p>
  297. </div>
  298. );
  299. }
  300. return (
  301. <div className="hackmd-preinit d-flex justify-content-center align-items-center">
  302. {content}
  303. </div>
  304. );
  305. }
  306. render() {
  307. const hackmdUri = this.getHackmdUri();
  308. const { pageContainer, t } = this.props;
  309. const {
  310. markdown, pageIdOnHackmd,
  311. } = pageContainer.state;
  312. let content;
  313. if (this.state.isInitialized) {
  314. content = (
  315. <HackmdEditor
  316. ref={(c) => { this.hackmdEditor = c }}
  317. hackmdUri={hackmdUri}
  318. pageIdOnHackmd={pageIdOnHackmd}
  319. initializationMarkdown={this.isResume ? null : markdown}
  320. onChange={this.hackmdEditorChangeHandler}
  321. onSaveWithShortcut={(document) => {
  322. this.onSaveWithShortcut(document);
  323. }}
  324. onPenpalErrorOccured={this.penpalErrorOccuredHandler}
  325. >
  326. </HackmdEditor>
  327. );
  328. }
  329. else {
  330. content = this.renderPreInitContent();
  331. }
  332. return (
  333. <div className="position-relative">
  334. {content}
  335. { this.state.hasError && (
  336. <div className="hackmd-error position-absolute d-flex flex-column justify-content-center align-items-center">
  337. <div className="bg-box p-5 text-center">
  338. <h2 className="text-warning"><i className="icon-fw icon-exclamation"></i> {t('hackmd.integration_failed')}</h2>
  339. <h4>{this.state.errorMessage}</h4>
  340. <p className="card well text-danger">
  341. {this.state.errorReason}
  342. </p>
  343. {/* eslint-disable-next-line react/no-danger */}
  344. <p dangerouslySetInnerHTML={{ __html: t('hackmd.check_configuration') }} />
  345. </div>
  346. </div>
  347. ) }
  348. </div>
  349. );
  350. }
  351. }
  352. /**
  353. * Wrapper component for using unstated
  354. */
  355. const PageEditorByHackmdWrapper = withUnstatedContainers(PageEditorByHackmd, [AppContainer, PageContainer, EditorContainer]);
  356. PageEditorByHackmd.propTypes = {
  357. t: PropTypes.func.isRequired, // i18next
  358. appContainer: PropTypes.instanceOf(AppContainer).isRequired,
  359. pageContainer: PropTypes.instanceOf(PageContainer).isRequired,
  360. editorContainer: PropTypes.instanceOf(EditorContainer).isRequired,
  361. };
  362. export default withTranslation()(PageEditorByHackmdWrapper);