Opengraph content embedding

marcozambi

Flarum ISAA Opengraph content embedding

Before...

After

Installation

To install, use composer:

composer require isaa/flarum-isaa-opengraph

Usage

Install extension via Composer / Packagist
Enable extension in the admin/extensions of Flarum

Description

The Open Graph protocol enables any web page to become a rich object in a social graph.
This is our first attempt in writing flarum extensions and has to be considered early alpha.
The last URL in a flarum post is followed and, if any OpenGraph meta is present in the linked resource, its content gets embedded at the bottom of the post.
We do not have a list of supported website, as the only pre-requisite for this extension to work is that the linked page offers at least a Title and a URL as opengraph meta tags. Content is embedded following a simple template: "Title - Optional description - Link to content - Optional Image".
If neither title nor url are not available, nothing gets embedded.

Changelog

2016-09-05: Version 0.1 Alpha 1
- First commit (for flarum ver. 0.1.0-beta.5)

Known issues / Future features

flarum already offers partial open graph embedding through mediaembed extension. If mediaembed is installed in your flarum forum, for some domains such as Twitter, Facebook and Google+ the embedding is duplicated (we'll try to solve this in upcoming releases).
"Read more..." string is hard coded. We have to understand better how to use internationalisation features of flarum. ?

Credits and copyright

The original code for the OpenGraph class is Copyright 2010 Scott MacVicar and released under Apache License, Version 2.0. Original can be found at https://github.com/scottmac/opengraph/blob/master/OpenGraph.php.

Help us

Feel free to contribute to this project, any suggestion is MORE than welcome!

AllysonSouzaNopSai

marcozambi
Nice job!
It's a great idea, but maybe you can create some css in Open Graph to make a difference from post content.

meetdilip

Awesome !!

marcozambi

Hello everybody,
I know it sounds a bit stupid, but regarding this extension, I have no trobule whatsoever in running it on my test environment, but I cannot install it on a vanilla flarum install.

I added the extension to packagist repo with no problems, I validated the composer.json with composer itself, no errors nor warning, but when on my flarum server I try to install the extension I have the following error:

[InvalidArgumentException]

Could not find package flarum-isaa-opengraph at any version for your minimum-stability (beta). Check the package spelling or your minimum-stability

I really cannot figure it out what should I change in my composer.json, which is as follows:

{
    "name": "isaa/flarum-isaa-opengraph",
    "description": "Opengraph for flarum.",
    "type": "flarum-extension",
    "keywords": ["opengraph", "flarum", "embedding"],
    "license": "MIT",
    "authors": [
        { "name": "Marco Zambianchi for ISAA Techcnical Team", "email": "marco.zambianchi@isaa.it" }
    ],
    "support": {
        "issues": "https://github.com/ItalianSpaceAstronauticsAssociation/flarum-isaa-opengraph/issues",
        "source": "https://github.com/ItalianSpaceAstronauticsAssociation/flarum-isaa-opengraph"
    },
    "require": {
        "flarum/core": "^0.1.0-beta.5"
    },
    "extra": {
        "flarum-extension": {
            "title": "OpenGraph"
        }
    },
    "autoload": {
        "psr-4": {
          "ISAA\\OpenGraph\\": "src/"
        }
    }
}

What the heck am I dong wrong?

NikolaiMorozov

You should draft new release in github and configure GitHub Service Hook.

marcozambi

NikolaiMorozov
Thank you very much! This did the trick. Something useful to mention in an ideal Extension developer guide. ?

wignu

Very nice extension indeed, just took it for a test drive and it worked nicely.

One 'wish for' would be the ability to set number of characters for the preview text as well as the suggestion from @AllysonSouzaNopSai above ?.

marcozambi

Thanks for your feedback. This release is really just an alpha. We will certainly improve along time.

FBI

This is cool, can fill the gap of unlisted site from other Embedded Media extension.
Good job ?

FBI

suggestion:
- only for Media Embedded extension user,
- sometime, we dont want to double embedded posts (which is already support by Media Embedded)
- then, during editing this plugin shouldn't checked or should not run.. Only work on create discussion & reply only ?

marcozambi

FBI You are right.
Actually I am curious about how to "detect" whether a certain plugin is already installed and avoid duplication in embedding. As soon as I find out, I'll check the presence of Mediaembed and disable my plugin for G+, Facebook, Twitter links (and others if suggested, maybe also as configurable behavior).

I just hope that some more documentation is released after beta 6 to help extensions developers. ?

FBI

Yeah, just like when I am developed plugins for MyBB.
It need, hook-list the documentation ?

rnovino

Awesome this is what I need ?

SUGGESTION: you might want to consider doing css on this one just like the implementation of FB Embed here is my sample idea.

additional reference

wignu

rnovino Very nice examples there, my pref would be for the one with the image on the left however either would be cool ?.

@Davis Oooh yes, would be nice integrated into a single extension (if that's what you mean by point 2?)

Keep up the great work @marcozambi

Tavousi

Awsome bud

orpheus

Does this one work with Beta6?

marcozambi

Hello everybody, I'll test the extension with beta 6 in the next few days.
Thanks for all the suggestions, I'll try my best!

rnovino

marcozambi I tested it and it works fine ? on Beta 6

Davis

Just a little feedback:

Flarum uses the following naming scheme: author/flarum-ext-packagename. Both your repo and namespaces should reflect this.
You could probably turn this into a pull request for the media embed extension.
Styling the embed is a must.

But good work! Keep writing extensions.

marcozambi

Davis You're absolutely right. Unfortunately I had to temprarily slow donwn my efforts on developing this. A lot of time goes into reading other people code, then proceeding by trial and errors.

I really believe that an up-to-date and a bit more thorough documentation on how to develop good extensions is mandatory after the stable is out.

I'll be more than happy to better this Extension, but I can really use a bit more documentation ?

rnovino

UPDATE: when I pasted a youtube video it also generates an opengraph, hopefully there is way for users to toggle if in case they don't want to automatically generate the opengraph since some users just paste the url of youtube and that might be annoying if we pasted several videos it will look like a duplicated content.

wwwill

JoshyPHP Let's say I have OpenGraph and EmbedMedia installed on my Flarum

If I type :

https://www.youtube.com/watch?v=dQw4w9WgXcQ

I will have the situation described by rnovino : The video thru EmbedMedia + the opengraph info

If I type :

[https://www.youtube.com/watch?v=dQw4w9WgXcQ](https://www.youtube.com/watch?v=dQw4w9WgXcQ)

[https://www.youtube.com/watch?v=dQw4w9WgXcQ][1]
  [1]: https://www.youtube.com/watch?v=dQw4w9WgXcQ

or ONLY if BBcode is activated

[url]https://www.youtube.com/watch?v=dQw4w9WgXcQ[/url]

I see the URL (because EmbedMedia does its job
BUT I will see the OpenGraph too. This is a bug.

If I type :

[media]https://www.youtube.com/watch?v=dQw4w9WgXcQ[/media]

I will see the video thru EmbedMedia ONLY IF BBcode is activated
BUT I will see the OpenGraph too. This is a bug.

And how can I see only the OpenGraph then ?