Bryan Avery - Blog

How to move a Joomla website

b_avery@yahoo.com — Sat, 27 Feb 2016 20:56:00 +0000

So I've been volunteering for an NGO called Otra Cosa Network in Peru and as part of my volunteering I have been teaching young children to swim, but of course I get roped into helping with their website. A busman's holiday I know..!

So their existing website is using Joomla so the first step for me is to back a backup copy of the existing Joomla website.

I found JoomlaPack, which is now called Keeba Backup, which can be found here:

https://www.akeebabackup.com/download.html

They recommend you follow the videos on their website

https://www.akeebabackup.com/videos/1212-akeeba-backup-core/1615-abtc01-installation-first-backup.html

Now that you are able to backup the website, I needed to restore the live website to backup site, to do this you need to download Keeba KickStart and unzip the files, taking just the kickstart.php file which you'll need to add to the root folder of the new website, also copy across the backup file you wish to restore.

A backup of your web site is only useful if you can restore it - perhaps you need to transfer your web host or even move the site from a development server to a live server.

Like always I have attached the version I worked with at the bottom of this post.

Here is a step by step process for you to restore the backup you have just taken:

Or you can watch the video here

To begin with, take a brand new backup of your web site.
Once the backup is complete, go to Manage Backups and download the backup file to your computer.
Now we've downloaded the backup file, we need an additional program called Kickstart which you can find at the akeebabackup.com web site.
Go to downloads. Scroll down to Akeeba Kickstart and click Download to download the file to your computer.
The Kickstart program is NOT a Joomla extension. Here we can see that the Kickstart program is a zip file and we need to extract that.
On most operating systems you can do that simply by double clicking on the file name.
We can see we now have a new folder with all the kickstart files in it.
The only one that you actually need is the kickstart.php file; all the rest are language translations.
We now need to transfer the kickstart.php and our backup to our brand new web host, and to do that we will use a FTP program.
I am going to use filezilla but you can use any ftp program that you like.
To begin with, connect to your NEW server.
Once connected, make sure you are in the public html or the web root of your server.
Now you need to transfer the backup file from our local computer to our live server. I am just going to pick that up and drag it across.
You can see the upload is taking place. We now have the backup file on the new server.
We now need to take that kickstart.php file and do exactly the same thing. Select it and drag it across.
That's it with the filezilla for now so let's go back to our web browser and go to our brand new web site.
As you can see I have a holding page in place to show that the web site is coming soon.
So just go to the special url for kickstart.php. The kickstart program is now running.
Kickstart is NOT an installation program, it is a special archive extraction tool.
We can click here to remove this message and we can see here that it has detected the archive file.
We have several methods of extracting the files. On most good web hosts, we can use the hybrid method.
Finally click START to begin the extract process.
Kickstart has now extracted the backup file and provides a link to the installer that was built in to that backup.
The installer is a very simple process. We begin with the required settings. As you can see, they are all set to yes. If any are set to No, you won't be able to proceed and you need to speak to your web hosts to rectify the errors.
We can now click Next.
I know need to enter the database connection details that I have got from my web host.
Enter the server hostname (which is usually localhost, but that may depend on your hosting) and your DATABASE username and password. And finally the database name that you want to install your web site on. Again this is something that your host will have provided to you or you will have set up yourself within your hosts control panel.
And click next.
The restoration process of the database has now been processed and we can click to continue.
We have now have the opportunity if we wish to change the site name and the email address. In most cases when you are restoring a site you won't need to do this.
If we scroll down there is also the opportunity to change the password and email address of the Super Administrator.
Finally, click Next again.
The sites configuration has all been setup.
Now what we need to do is close this window and when we are now back at the Akeeba Kickstart program and click on Cleanup.
This will remove the kickstart.php file and that big backup archive.
Now that we're done we can visit our website and here we can see that the web site has now been transferred from our old hosting account to our new one.

com_akeeba-4.5.5-core.zip (2.48 mb)

kickstart-core-4.1.4.zip (267.22 kb)

The way to handle unauthorised requests to Ajax actions in ASP.NET MVC

b_avery@yahoo.com — Thu, 18 Dec 2014 10:12:00 +0000

Problem

I have created a view that posts to an action via Ajax with the expectation that the action will return the requested data or an empty string. Even better, I would like it to be configurable to return whatever value I see fit.

The problem arises when I decorate the called action with the [Authorize] attribute. If the request is not authorized and I have a loginUrl configured in my web.config, my ajax request will return the html output of my loginUrl view. That is undesirable.

Solution

I can extend the existing Authorize attribute by inheriting from the AuthorizeAttribute class. Here is the code that extends the Authorize attribute:

public class AjaxAuthorizeOverrideAttribute : AuthorizeAttribute
    {
        public string View { get; set; }

        protected override void HandleUnauthorizedRequest(AuthorizationContext filterContext)
        {
            if (!filterContext.HttpContext.Request.IsAjaxRequest())
            {
                base.HandleUnauthorizedRequest(filterContext);
                return;
            }

            filterContext.Result = new ViewResult { ViewName = View };
            filterContext.Result.ExecuteResult(filterContext.Controller.ControllerContext);
        }
    }

Here is the decorator for the ajax action in the controller class:

[AjaxAuthorizeOverride(View="AjaxAuthorizeError")]

public ActionResult AjaxRequest()
{
     return View();
}

Note: there is no default view page being rendered.

Original article can be found here

Creating and Publishing to NuGet

b_avery@yahoo.com — Fri, 23 May 2014 07:13:00 +0000

Now that we have a Nuget Server installed and up and running we will want to deploy our packages.

First you'll need to install the nuget.exe command line bootstrapper

Installing NuGet.exe

Download NuGet.exe
Place NuGet in a well known location such as c:\utils on your machine
Make sure that NuGet.exe is in your path

Then you can take two simple steps to generate your package

nuget pack MyProject.csproj -IncludeReferencedProjects -Prop Configuration=Release

then push your pack to the nuget server, with your APIKey you setup in your web.config of the nuget.server

nuget push {package file} -s http://yourNugetServer/ {apikey}

That is it, you now have your package available in your own private nuget server.

For more details on Creating and Publishing a Package

Setting up a NuGet Server

b_avery@yahoo.com — Fri, 23 May 2014 06:59:00 +0000

Whether it's your company restricts which third-party libraries their developers may use or just you need your own private repository to store all your protected work. A NuGet Server is what you are after.

Before I start I need to mention a few things about NuGet Gallery, which I spent a good two days trying to get working correctly on Azure and failed and in the end ended up generating a very basic Nuget Server to host all the libraries.

This all can be done with just four simple steps

Create a new ASP.net Web Forms Application
Install nuget.server (http://www.nuget.org/packages/nuget.server)
edit your web.config to set your APIKey <add key="apiKey" value=""/>
Deploy your application to your website

That is it, if you fire up your server you should see a screen like this:

That is it you now have a hosted Nuget Server, next we'll look at deploying your solution to the Nuget Server

Full details can be found here: Host Your Own NuGet Server or How To Create Local NuGet Server

User Stories

b_avery@yahoo.com — Tue, 20 May 2014 08:30:00 +0000

Here are some helpful pointers for writing User Stories

A Story template

"As a <User or role>
I want <Business Functionality>
So that <Business Justification>”

Example:

As a Account Holder,
I want to be able to withdraw funds from my checking account,
So that I can buy some bling.

Stories are not

"mini" Use Cases
a complete specification
a contract
intended to be interpreted without a Product Owner

User Stories guidelines

Testable - Tangible acceptance tests can be written against any delivered software
The scope of the User Story is manage-able enough for the team to provide an Estimate
Independent and do not rely on other Stories
Sized appropriately.. Have a level of effort which the team can comfortably achieve in the duration of a single iteration

More information can be found http://www.mountaingoatsoftware.com/agile/user-stories

GitHub for web Designers

b_avery@yahoo.com — Tue, 25 Mar 2014 08:44:00 +0000

Unless you’re a one person web shop with no team to collaborate with, you've experienced the frustration that goes along with file sharing. No matter how hard you try, when multiple people are working on a single project without a version control system in place things get chaotic.

If you work with developers on the build-out and implementation of websites, the merge between front-end templates and back-end functionality can be a scary black hole.

Issues like overwrites, lost files, and the all-too-common “working off a previous version” phenomenon crop up constantly. And once back-end functionality has been put into your templates, you become terrified to touch them for fear of breaking something a developer spent a great deal of time getting to work.

In addition, even if you have a common repository that everyone is pulling from odds are at least one member of your team forgot to grab the latest files and is about to blow things up with their latest additions.

Fear not GitHub is here to save the day, I’ll give you a quick review of GitHub, an excellent version control system.

Version Control – A Quick and Dirty Explanation

Version Control (also known as Revision Control or Source Control Management) is a great way to solve the file sharing problem.

The basic concept is this: there is one main repository for all of the project files. Team members check files out, make changes, and then check them back in (or commit them). The Version Control System (VCS) automatically notes who changed the files, when they were changed, and what about them was new or different.

It also asks you to write a little note about the change so everyone on the project knows at a glance what you did and why. Each file will then have a revision history so you can easily go back to a previous version of any file if something goes horribly wrong.

A good Version Control System also allows you to merge changes to the same file. If you and another person work locally on the same file at the same time, when you push these files back into the main repository the system will merge both sets of changes to create a new and fully up-to-date file. If any conflicts arise during the merge it will highlight them for you.

You’re probably using a very crude Version Control System right now to keep your files straight. If you’re a designer, it looks something like this:

This works well enough for PSDs and other large binary files, which don’t really lend themselves to Version Control System. But there’s a much better way to do it when you are managing the source code for a website.

Benefits to using a Version Control System include:

Files cannot be overwritten
There is a common repository that holds all the latest files
People can work on the same files simultaneously without conflict
Allows you to revert back to an older version of the file/project if needed
Making your developers very happy

Even if you don’t work with a team, version control can be a lifesaver. Backing up files is one of the easiest things you can do to save yourself from losing work or having to start over.

The idea of a Version Control System seems daunting at first, especially since most of the documentation is written by and for developers. But once you make the move to incorporate it into your workflow, you’ll find it’s not nearly as hard as it looks.

Meet GitHub

OK, so now you can see why a Version Control System is a must-have for your web team. If you do a little Googling you’ll see that there are quite a few options out there including SVN, Mercurial, CVS, Bazaar and GitHub. Any one of them could be a good solution for your needs, and I encourage you to do some research before selecting a Version Control System. In this article I’m going to focus on GitHub, the one I use daily. It’s a “rising star” that has gained popularity thanks to a strong Linux fanbase, GitHub and the Rails community.

GitHub is a free open-source Version Control System originally created by Linus Torvalds for Linux kernal development. Linus is a very smart guy; when he sets out to solve a problem, he doesn't mess around. One of Git’s big differentiators is that unlike SVN and CVS it is a distributed version control system. This means that every user has a complete copy of the repository data stored locally on their machine. What’s so great about that? A few things:

Everything is local, so you can work offline
There is no single point of failure. It doesn't rely on one central server that could crash and burn, taking the only repository for your project with it.
Because it doesn't have to communicate with a central server constantly, processes run much faster

Git has a slightly tougher learning curve than SVN, but the trade-off is worth it. Just think how impressed your developer friends will be when you tell them you’re using the new hotness that is Git! In all seriousness, I don’t think the learning curve is all that steep.

Installing Git isn't fun and games. But there are plenty of resources online to get you through it. It will run on a PC, Mac or Linux box, although installation for Linux and OSX is considerable easier than for Windows.

You can download the latest version of Git here. Once you have the files, try this quick guide to get you started with the installation process. For Windows users, this step-by-step visual guide should be helpful. Mac users, try this guide found on GitHub

Original Article

Google authentication get email from ASP.NET Identity

b_avery@yahoo.com — Sat, 08 Mar 2014 06:47:00 +0000

So how do you obtain the external user email (the one authentication by google), first name and name in an ASP.NET website using ASP.NET Identity?

var email = externalIdentity.FindFirstValue(ClaimTypes.Email);

and here is getting the type

public static string FindFirstValue(this ClaimsIdentity identity, string claimType) 
    {
        Claim claim = identity.FindFirst(claimType);
        if (claim != null) 
        {
            return claim.Value;
        }
        return null;
    }

For more information take a look at Decoupling OWIN external authentication from ASP.NET Identity

WCF Attributes and what they all mean

b_avery@yahoo.com — Sun, 02 Feb 2014 13:01:00 +0000

The online MSDN documentation is your first source for things like that:

Read about the ServiceContractAttribute
Read about the OperationContractAttribute
Read about the DataContractAttribute

All the MSDN documentation pages contain detailed explanations of all the settings on those contract attributes.

Active links on Bootstrap Navbar with ASP.NET MVC

b_avery@yahoo.com — Mon, 20 Jan 2014 14:06:00 +0000

If you have used Bootstrap with your ASP.NET MVC application, you might have faced some issues with implementing active links of it’s Navbar component. We’ll have to dynamically add a css class called active to the particular menu item in order to make it selected in the Navbar. Here is a HtmlHelper extension which is capable of rendering menu items as well as drop-down menu items. I’ve used ASP.NET MVC 5 with Razor and Bootstrap 3.

First step is to create a HtmlHelper extension class.

using System.Web.Mvc;

public static class MenuLinkExtension
{
    public static MvcHtmlString MenuLink(this HtmlHelper htmlHelper, string itemText, string actionName, string controllerName, MvcHtmlString[] childElements = null)
    {
        var currentAction = htmlHelper.ViewContext.RouteData.GetRequiredString("action");
        var currentController = htmlHelper.ViewContext.RouteData.GetRequiredString("controller");
        string finalHtml;
        var linkBuilder = new TagBuilder("a");
        var liBuilder = new TagBuilder("li");

        if (childElements != null && childElements.Length > 0)
        {
            linkBuilder.MergeAttribute("href", "#");
            linkBuilder.AddCssClass("dropdown-toggle");
            linkBuilder.InnerHtml = itemText + " <b class=\"caret\"></b>";
            linkBuilder.MergeAttribute("data-toggle", "dropdown");
            var ulBuilder = new TagBuilder("ul");
            ulBuilder.AddCssClass("dropdown-menu");
            ulBuilder.MergeAttribute("role", "menu");
            foreach (var item in childElements)
            {
                ulBuilder.InnerHtml += item + "\n";
            }

            liBuilder.InnerHtml = linkBuilder + "\n" + ulBuilder;
            liBuilder.AddCssClass("dropdown");
            if (controllerName == currentController)
            {
                liBuilder.AddCssClass("active");
            }

            finalHtml = liBuilder.ToString() + ulBuilder;
        }
        else
        {
            var urlHelper = new UrlHelper(htmlHelper.ViewContext.RequestContext, htmlHelper.RouteCollection);
            linkBuilder.MergeAttribute("href", urlHelper.Action(actionName, controllerName));
            linkBuilder.SetInnerText(itemText);
            liBuilder.InnerHtml = linkBuilder.ToString();
            if (controllerName == currentController && actionName == currentAction)
            {
                liBuilder.AddCssClass("active");
            }

            finalHtml = liBuilder.ToString();
        }

        return new MvcHtmlString(finalHtml);
    }
}

Once you have saved it, you can it by just calling like this!

<header class="navbar navbar-inverse navbar-fixed-top bs-docs-nav" role="banner">
    <div class="container">
        <div class="navbar-header">
            <a href="#" class="navbar-brand">Mvc Shop</a>
        </div>
        <nav role="navigation">
 
            <ul class="nav navbar-nav">
                @Html.MenuLink("Home", "Index", "Home")
                @Html.MenuLink("Dropdown", "Index", "Home2", new MvcHtmlString[]{
                                      @Html.MenuLink("Link1", "Action1", "Controller1"),
                                      @Html.MenuLink("Link2", "Action2", "Controller1"),
                                      @Html.MenuLink("Link3", "Action3", "Controller1"),
                                    })
                @Html.MenuLink("JavaScript", "Index", "Home1", new MvcHtmlString[]{
                                      @Html.MenuLink("Link1", "Index1", "Home1"),
                                      @Html.MenuLink("Link2", "Index2", "Home1"),
                                      @Html.MenuLink("Link3", "Index3", "Home1")
                                    })
 
            </ul>
        </nav>
    </div>
</header>

How to Rank your search results with multiple search terms using LINQ and EntityFramework

b_avery@yahoo.com — Tue, 31 Dec 2013 11:59:00 +0000

I have always used a ranked search criteria, it's the only true way to get good results back from a data set. But I've been doing my ranking within C# code. But this got all the data from the data source and then ranked the results. This is very poor on performance, as we should only be returning back the results for the page size we require.

So task at hand it to produce a LINQ statement to reterive only the data you require.

Here is the solution:

var entity = new myEntities();

var searchTerm = "a b Ba";

var searchArray = searchTerm.Split(new[] { ' ' }, StringSplitOptions.RemoveEmptyEntries);

var usersAll = entity.User.AsExpandable().Where(TC_User.ContainsInLastName(searchArray));

Console.WriteLine("Total Records: {0}", usersAll.Count());

var users = usersAll
    .Select(x => new { 
        x.LastName, 
        Rank = searchArray.Sum(s => ((x.LastName.Length - x.LastName.Replace(s, "").Length) / s.Length)) });

var results = users.OrderByDescending(o => o.Rank)
    .Skip(0)
    .Take(20);

foreach (var user in results)
{
    Console.WriteLine("{0}, {1}", user.LastName, user.Rank);
}

Console.ReadLine();

You'll also need to add a new method to your User class to check for that the search term is contain in the LastName

public static Expression<Func<TC_User, bool>> ContainsInLastName(
                                                params string[] keywords)
{
    var predicate = PredicateBuilder.False<TC_User>();
    foreach (string keyword in keywords)
    {
        string temp = keyword;
        predicate = predicate.Or(p => p.LastName.Contains(temp));
    }
    return predicate;
}

One thing that is required is LinqKit, which is available via NuGet to handle the PredicateBuilder and AsExpandable.

Watch out as the results coming back from Sum is a BigInt so if you create a model to return back make sure it is a long type.