Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Beta master #643

Merged
merged 21 commits into from
Oct 31, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
21 commits
Select commit Hold shift + click to select a range
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
83 changes: 33 additions & 50 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,15 +45,28 @@ The Verification plugin is a browser based plugin built with React and Redux.

3. Add an `.env` file at the root containing
```
REACT_APP_ELK_URL=<ELK-URL>/twinttweets/_search
REACT_APP_TWINT_WRAPPER_URL=<TWINT-WRAPPER-URL>
REACT_APP_FACEBOOK_APP_ID=<REACT_ID>
REACT_APP_TRANSLATION_GITHUB=https://raw.githubusercontent.com/AFP-Medialab/InVID-Translations/react/
REACT_APP_KEYFRAME_TOKEN=<yourKeyframeToken>
REACT_APP_MY_WEB_HOOK_URL=<yourSlackAppUrlHook>
REACT_APP_GOOGLE_ANALYTICS_KEY=<yourGoogleAnaliticsToken>
REACT_APP_MAP_TOKEN=<MAP_TOKEN>
REACT_APP_BASEURL=<TWINT-WRAPPER-URL>
REACT_APP_KEYFRAME_API=<keyframe_url>
REACT_APP_MY_WEB_HOOK_URL=<slack_webhook_url>
REACT_APP_TRANSLATION_URL=<translation_server_url>
REACT_APP_TRANSLATION_TAG=<The current translation tag, e.g. v0.83>
REACT_APP_TSNA_SERVER=<tsna_url>
REACT_APP_ASSISTANT_URL=<assistant_url>
REACT_APP_DBKF_SEARCH_API=<dbkf_url>
REACT_APP_DBKF_SIMILARITY_API=<dbkf_similarity_url>
REACT_APP_BASEURL=<baseurl>
REACT_APP_CAA_FORENSICS_URL=<forensics_url>
REACT_APP_CAA_ANALYSIS_URL=<analysis_url>
REACT_APP_CAA_ENVISU4_UTILS_URL=<envisu4_url>
REACT_APP_CAA_DEEPFAKE_URL=<deepfake_url>
REACT_APP_CAA_LOCATION_URL=<location_url>
REACT_APP_MATOMO_URL=<matomo_url>
REACT_APP_MATOMO_DOMAIN=<matomo_domain>
MATOMO_SITE=<matomo_site>
REACT_APP_VIDEORIGHT_API=<videoright_url>
REACT_APP_LOCCUS_URL=<loccus_url>
REACT_APP_AFP_REVERSE_SEARCH_URL=<reversesearch_url>
REACT_APP_SEMANTIC_SEARCH_URL=<semanticsearch_url>
ARCHIVE_BACKEND=<archive_url>
```

## Build the project
Expand All @@ -65,67 +78,31 @@ The Verification plugin is a browser based plugin built with React and Redux.

- Run the `build` to build the React app for production
```
npm run build
npm run build
```


## Load the extension on the browser

#### Google Chrome / Chromium-based browsers

[Chrome for Developers documentation](https://developer.chrome.com/docs/extensions/get-started/tutorial/hello-world#load-unpacked)

- Go to the Extensions page by entering [chrome://extensions/](chrome://extensions/) in a new tab.
- Go to the Extensions page by entering [chrome://extensions/](chrome://extensions/) in a new tab.
- Enable **Developer Mode** by clicking the toggle switch next to Developer mode.
- Click the **Load unpacked** button and select the extension directory (go inside the `build` folder).

#### Firefox ( ⚠️ deprecated)

- In firefox menu click on `Add-ons`
- Then click on the gear button `⚙⌄`
- Then click on `Debug Add-ons`
- Then click on `Load TEmporary Add-on...`
- Select the `manifest.json` in the `dev` or `build` file you generated earlier.

## Project folders structure

`public` the configuration files for an extension `manifest.json` and the root html file `popup.html`

`src/background` scripts executed in the web browser background by the extension. The contextual menu for example.

`src/Hooks` Custom hooks used in this project.

`src/LocalDictionary` The offline translation files fallback used when the server cannot provide the translation

`src/redux` react-redux actions and
reducers. [Documentation](https://react-redux.js.org/)

`src/components` The main custom React components used in this project.

`src/components/Shared` Small React components reused in other components.

`src/components/FeedBack`The FeedBack tool

`src/components/PopUp` The extension's PopUp

`src/components/MySnackBar` The arrow to get back to the top of the page.

`src/components/Navbar` The NavBar and its Drawer (for tools)

`src/components/NavItems` All the components displayed by the navBar.

`src/components/NavItems/tools` All components that the `tools drawer` can display.

## Testing

The [playwright](https://playwright.dev/) framework is used for e2e, component and unit testing. All tests are located
in the `tests` folder with the following structure:

```
tests
!- component_unit - Component and unit testing
|- e2e - End to end testing
-- examples - Examples to serve as a reference only
-- examples - Examples to serve as a reference only
```

**Note: Before running all (or just e2e) tests, the extension must first be built. See End-to-end (e2e) testing section
Expand All @@ -134,15 +111,19 @@ for more details**
All tests (e2e, component & unit) can be run using the command:

```
npm run test
```

### Component and Unit testing

Component and unit testing are run together using the following command:

```
npm run test-cu
```

Playwright configurations of the component and unit tests can be found in `/playwright-ct.config.js`
Expand All @@ -167,7 +148,9 @@ tests.
E2E testing can be run using the following command:

```
npm run test-e2e
```

Playwright configurations of the e2e tests can be found in `/playwright.config.ts`.
Expand Down
1 change: 1 addition & 0 deletions src/components/NavBar/images/SVG/Others/archive-icon.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
10 changes: 10 additions & 0 deletions src/components/NavBar/images/SVG/Others/perma-cc-icon.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
136 changes: 136 additions & 0 deletions src/components/NavItems/tools/Archive/components/urlArchive.jsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,136 @@
import {
Box,
Button,
Grid2,
Icon,
Link,
Stack,
Tooltip,
Typography,
} from "@mui/material";
import { i18nLoadNamespace } from "components/Shared/Languages/i18nLoadNamespace";
import { useEffect, useState } from "react";
import IconPermaCC from "../../../../NavBar/images/SVG/Others/perma-cc-icon.svg";
import IconInternetArchive from "../../../../NavBar/images/SVG/Others/archive-icon.svg";

const UrlArchive = ({ url, openLinks }) => {
const [platform, setPlatform] = useState(null);
const [urls, setUrls] = useState([]);

const keyword = i18nLoadNamespace("components/NavItems/tools/Archive");

useEffect(() => {
if (url && url.includes("facebook")) {
setPlatform("facebook");
} else if (url && url.includes("youtube")) {
setPlatform("youtube");
} else if (url && url.includes("instagram")) {
setPlatform("instagram");
}
}, [url]);

useEffect(() => {
if (platform === "facebook") {
const facebookUrls = [
`https://www.facebook.com/plugins/post.php?href=${encodeURIComponent(
url,
)}&show_text=true&width=500`,
`https://www.facebook.com/v16.0/plugins/post.php?app_id=&channel=https%3A%2F%2Fstaticxx.facebook.com%2Fx%2Fconnect%2Fxd_arbiter%2F%3Fversion%3D46%23cb%3Dfe3fbda33dec3%26domain%3Ddevelopers.facebook.com%26is_canvas%3Dfalse%26origin%3Dhttps%253A%252F%252Fdevelopers.facebook.com%252Ff8686a44c9f19%26relation%3Dparent.parent&container_width=734&href=${encodeURIComponent(
url,
)}&set=a.462670379217792&locale=en_US&sdk=joey&show_text=true&width=500`,
`https://mbasic.facebook.com/${url.replace(
"https://www.facebook.com/",
"",
)}`,
];
setUrls(facebookUrls);
} else if (platform === "youtube") {
const youtubeUrls = [url.replace("/watch?v=", "/embed/")];
setUrls(youtubeUrls);
} else if (platform === "instagram") {
const instagramUrls = [url + "embed/captioned"];
setUrls(instagramUrls);
}
}, [platform]);

const saveToInternetArchive = (link) => {
window.open("https://web.archive.org/save/" + link, "_blank");
};

const ArchiveLink = ({ link, link_type_keyword }) => {
return (
<>
<Grid2 container>
<Typography>{keyword(link_type_keyword)}</Typography>
<Box p={1} />
<Tooltip title={keyword("permacc_button")}>
<Button>
<IconPermaCC />
</Button>
</Tooltip>
<Tooltip title={keyword("internet_archive_button")}>
<Button onClick={() => saveToInternetArchive(link)}>
<IconInternetArchive />
</Button>
</Tooltip>
</Grid2>
<Link href={link} pl={2}>
{link}
</Link>
</>
);
};

return (
<>
<Stack p={2} spacing={1}>
{platform === "facebook" ? (
<>
<Box p={1} />
<Grid2>
<Button
variant="contained"
color="primary"
onClick={() => {
urls.map((urlElement) => {
window.open(urlElement, "_blank");
});
}}
>
{keyword("open_links_button")}
</Button>
</Grid2>
<Stack spacing={2}>
<ArchiveLink link={urls[0]} link_type_keyword={"embed_link"} />
<ArchiveLink link={urls[1]} link_type_keyword={"android_link"} />
<ArchiveLink link={urls[2]} link_type_keyword={"mobile_link"} />
</Stack>
</>
) : (
<>
{platform === "youtube" ? (
<>
<ArchiveLink link={urls[0]} link_type_keyword={"embed_link"} />
</>
) : (
<>
{platform === "instagram" ? (
<>
<ArchiveLink
link={urls[0]}
link_type_keyword={"embed_link"}
/>
</>
) : (
<Typography>{keyword("unsupported_platform")}</Typography>
)}
</>
)}
</>
)}
</Stack>
</>
);
};

export default UrlArchive;
Loading